Module cups
[show private | hide private]
[frames | no frames]

Module cups

Classes
Attribute A PPD attribute.
Connection A connection to the CUPS server.
Constraint A PPD constraint.
Dest A destination print queue, as returned by Connection.getDests.
Group A PPD option group.
Option A PPD option.
PPD A PPD file.

Exceptions
HTTPError This exception is raised when an HTTP problem has occurred.
IPPError This exception is raised when an IPP error has occurred.

Function Summary
integer getEncryption()
Get encryption policy.
integer getPort()
Return iPP port to connect to.
string getServer()
Return server to connect to.
string getUser()
Return user to connect as.
integer modelSort(s1, s2)
Sort two model strings.
None require(version)
Require pycups version.
None setEncryption(policy)
Set encryption policy.
None setPasswordCB(fn)
Set password callback function.
None setPort(port)
Set IPP port to connect to.
None setServer(server)
Set server to connect to.
None setUser(user)
Set user to connect as.

Variable Summary
int CUPS_PRINTER_AUTHENTICATED = 4194304                                                               
int CUPS_PRINTER_BIND = 1024                                                                  
int CUPS_PRINTER_BW = 4                                                                     
int CUPS_PRINTER_CLASS = 1                                                                     
int CUPS_PRINTER_COLLATE = 128                                                                   
int CUPS_PRINTER_COLOR = 8                                                                     
int CUPS_PRINTER_COMMANDS = 8388608                                                               
int CUPS_PRINTER_COPIES = 64                                                                    
int CUPS_PRINTER_COVER = 512                                                                   
int CUPS_PRINTER_DEFAULT = 131072                                                                
int CUPS_PRINTER_DELETE = 1048576                                                               
int CUPS_PRINTER_DUPLEX = 16                                                                    
int CUPS_PRINTER_FAX = 262144                                                                
int CUPS_PRINTER_IMPLICIT = 65536                                                                 
int CUPS_PRINTER_LARGE = 16384                                                                 
int CUPS_PRINTER_LOCAL = 0                                                                     
int CUPS_PRINTER_MEDIUM = 8192                                                                  
int CUPS_PRINTER_NOT_SHARED = 2097152                                                               
int CUPS_PRINTER_OPTIONS = 458748                                                                
int CUPS_PRINTER_PUNCH = 256                                                                   
int CUPS_PRINTER_REJECTING = 524288                                                                
int CUPS_PRINTER_REMOTE = 2                                                                     
int CUPS_PRINTER_SMALL = 4096                                                                  
int CUPS_PRINTER_SORT = 2048                                                                  
int CUPS_PRINTER_STAPLE = 32                                                                    
int CUPS_PRINTER_VARIABLE = 32768                                                                 
str CUPS_SERVER_DEBUG_LOGGING = '_debug_logging'
str CUPS_SERVER_REMOTE_ADMIN = '_remote_admin'
str CUPS_SERVER_REMOTE_ANY = '_remote_any'
str CUPS_SERVER_REMOTE_PRINTERS = '_remote_printers'
str CUPS_SERVER_SHARE_PRINTERS = '_share_printers'
str CUPS_SERVER_USER_CANCEL_ANY = '_user_cancel_any'
int HTTP_BAD_REQUEST = 400                                                                   
int HTTP_ENCRYPT_ALWAYS = 3                                                                     
int HTTP_ENCRYPT_IF_REQUESTED = 0                                                                     
int HTTP_ENCRYPT_NEVER = 1                                                                     
int HTTP_ENCRYPT_REQUIRED = 2                                                                     
int HTTP_ERROR = -1                                                                    
int HTTP_FORBIDDEN = 403                                                                   
int HTTP_NOT_FOUND = 404                                                                   
int HTTP_OK = 200                                                                   
int HTTP_REQUEST_TIMEOUT = 408                                                                   
int HTTP_SERVER_ERROR = 500                                                                   
int HTTP_UNAUTHORIZED = 401                                                                   
int HTTP_UPGRADE_REQUIRED = 426                                                                   
int IPP_ATTRIBUTES = 1035                                                                  
int IPP_ATTRIBUTES_NOT_SETTABLE = 1043                                                                  
int IPP_BAD_REQUEST = 1024                                                                  
int IPP_CHARSET = 1037                                                                  
int IPP_COMPRESSION_ERROR = 1040                                                                  
int IPP_COMPRESSION_NOT_SUPPORTED = 1039                                                                  
int IPP_CONFLICT = 1038                                                                  
int IPP_DEVICE_ERROR = 1284                                                                  
int IPP_DOCUMENT_ACCESS_ERROR = 1042                                                                  
int IPP_DOCUMENT_FORMAT = 1034                                                                  
int IPP_DOCUMENT_FORMAT_ERROR = 1041                                                                  
int IPP_ERROR_JOB_CANCELLED = 1288                                                                  
int IPP_FINISHINGS_BALE = 12                                                                    
int IPP_FINISHINGS_BIND = 7                                                                     
int IPP_FINISHINGS_BIND_BOTTOM = 53                                                                    
int IPP_FINISHINGS_BIND_LEFT = 50                                                                    
int IPP_FINISHINGS_BIND_RIGHT = 52                                                                    
int IPP_FINISHINGS_BIND_TOP = 51                                                                    
int IPP_FINISHINGS_BOOKLET_MAKER = 13                                                                    
int IPP_FINISHINGS_COVER = 6                                                                     
int IPP_FINISHINGS_EDGE_STITCH = 9                                                                     
int IPP_FINISHINGS_EDGE_STITCH_BOTTOM = 27                                                                    
int IPP_FINISHINGS_EDGE_STITCH_LEFT = 24                                                                    
int IPP_FINISHINGS_EDGE_STITCH_RIGHT = 26                                                                    
int IPP_FINISHINGS_EDGE_STITCH_TOP = 25                                                                    
int IPP_FINISHINGS_FOLD = 10                                                                    
int IPP_FINISHINGS_JOB_OFFSET = 14                                                                    
int IPP_FINISHINGS_NONE = 3                                                                     
int IPP_FINISHINGS_PUNCH = 5                                                                     
int IPP_FINISHINGS_SADDLE_STITCH = 8                                                                     
int IPP_FINISHINGS_STAPLE = 4                                                                     
int IPP_FINISHINGS_STAPLE_BOTTOM_LEFT = 21                                                                    
int IPP_FINISHINGS_STAPLE_BOTTOM_RIGHT = 23                                                                    
int IPP_FINISHINGS_STAPLE_DUAL_BOTTOM = 31                                                                    
int IPP_FINISHINGS_STAPLE_DUAL_LEFT = 28                                                                    
int IPP_FINISHINGS_STAPLE_DUAL_RIGHT = 30                                                                    
int IPP_FINISHINGS_STAPLE_DUAL_TOP = 29                                                                    
int IPP_FINISHINGS_STAPLE_TOP_LEFT = 20                                                                    
int IPP_FINISHINGS_STAPLE_TOP_RIGHT = 22                                                                    
int IPP_FINISHINGS_TRIM = 11                                                                    
int IPP_FORBIDDEN = 1025                                                                  
int IPP_GONE = 1031                                                                  
int IPP_IGNORED_ALL_NOTIFICATIONS = 1046                                                                  
int IPP_IGNORED_ALL_SUBSCRIPTIONS = 1044                                                                  
int IPP_INTERNAL_ERROR = 1280                                                                  
int IPP_JOB_ABORTED = 8                                                                     
int IPP_JOB_CANCELED = 7                                                                     
int IPP_JOB_COMPLETED = 9                                                                     
int IPP_JOB_HELD = 4                                                                     
int IPP_JOB_PENDING = 3                                                                     
int IPP_JOB_PROCESSING = 5                                                                     
int IPP_JOB_STOPPED = 6                                                                     
int IPP_MAX_NAME = 256                                                                   
int IPP_MULTIPLE_JOBS_NOT_SUPPORTED = 1289                                                                  
int IPP_NOT_ACCEPTING = 1286                                                                  
int IPP_NOT_AUTHENTICATED = 1026                                                                  
int IPP_NOT_AUTHORIZED = 1027                                                                  
int IPP_NOT_FOUND = 1030                                                                  
int IPP_NOT_POSSIBLE = 1028                                                                  
int IPP_OK = 0                                                                     
int IPP_OK_BUT_CANCEL_SUBSCRIPTION = 6                                                                     
int IPP_OK_CONFLICT = 2                                                                     
int IPP_OK_EVENTS_COMPLETE = 7                                                                     
int IPP_OK_IGNORED_NOTIFICATIONS = 4                                                                     
int IPP_OK_IGNORED_SUBSCRIPTIONS = 3                                                                     
int IPP_OK_SUBST = 1                                                                     
int IPP_OK_TOO_MANY_EVENTS = 5                                                                     
int IPP_OPERATION_NOT_SUPPORTED = 1281                                                                  
int IPP_PRINT_SUPPORT_FILE_NOT_FOUND = 1047                                                                  
int IPP_PRINTER_BUSY = 1287                                                                  
int IPP_PRINTER_IDLE = 3                                                                     
int IPP_PRINTER_IS_DEACTIVATED = 1290                                                                  
int IPP_PRINTER_PROCESSING = 4                                                                     
int IPP_PRINTER_STOPPED = 5                                                                     
int IPP_REDIRECTION_OTHER_SITE = 512                                                                   
int IPP_REQUEST_ENTITY = 1032                                                                  
int IPP_REQUEST_VALUE = 1033                                                                  
int IPP_SERVICE_UNAVAILABLE = 1282                                                                  
int IPP_TEMPORARY_ERROR = 1285                                                                  
int IPP_TIMEOUT = 1029                                                                  
int IPP_TOO_MANY_SUBSCRIPTIONS = 1045                                                                  
int IPP_URI_SCHEME = 1036                                                                  
int IPP_VERSION_NOT_SUPPORTED = 1283                                                                  
int PPD_UI_BOOLEAN = 0                                                                     
int PPD_UI_PICKMANY = 2                                                                     
int PPD_UI_PICKONE = 1                                                                     

Function Details

getEncryption()

Get encryption policy.
Returns:
integer

See Also: setEncryption

getPort()

Returns:
IPP port to connect to.
           (type=integer)

getServer()

Returns:
server to connect to.
           (type=string)

getUser()

Returns:
user to connect as.
           (type=string)

modelSort(s1, s2)

Sort two model strings.
Parameters:
s1 - first string
           (type=string)
s2 - second string
           (type=string)
Returns:
strcmp-style comparision result
           (type=integer)

require(version)

Require pycups version.
Parameters:
version - minimum pycups version required
           (type=string)
Returns:
None
Raises:
RuntimeError - requirement not met

setEncryption(policy)

Set encryption policy.
Parameters:
policy - HTTP_ENCRYPT_ALWAYS, HTTP_ENCRYPT_IF_REQUESTED, HTTP_ENCRYPT_NEVER, or HTTP_ENCRYPT_REQUIRED
           (type=integer)
Returns:
None

setPasswordCB(fn)

Set password callback function. This Python function will be called when a password is required. It must take one string parameter (the password prompt) and it must return a string (the password). To abort the operation it may return the empty string ('').
Parameters:
fn - callback function
           (type=callable object)
Returns:
None

setPort(port)

Set IPP port to connect to.
Parameters:
port - IPP port
           (type=integer)
Returns:
None

setServer(server)

Set server to connect to.
Parameters:
server - server hostname
           (type=string)
Returns:
None

setUser(user)

Set user to connect as.
Parameters:
user - username
           (type=string)
Returns:
None

Variable Details

CUPS_PRINTER_AUTHENTICATED

Type:
int
Value:
4194304                                                               

CUPS_PRINTER_BIND

Type:
int
Value:
1024                                                                  

CUPS_PRINTER_BW

Type:
int
Value:
4                                                                     

CUPS_PRINTER_CLASS

Type:
int
Value:
1                                                                     

CUPS_PRINTER_COLLATE

Type:
int
Value:
128                                                                   

CUPS_PRINTER_COLOR

Type:
int
Value:
8                                                                     

CUPS_PRINTER_COMMANDS

Type:
int
Value:
8388608                                                               

CUPS_PRINTER_COPIES

Type:
int
Value:
64                                                                    

CUPS_PRINTER_COVER

Type:
int
Value:
512                                                                   

CUPS_PRINTER_DEFAULT

Type:
int
Value:
131072                                                                

CUPS_PRINTER_DELETE

Type:
int
Value:
1048576                                                               

CUPS_PRINTER_DUPLEX

Type:
int
Value:
16                                                                    

CUPS_PRINTER_FAX

Type:
int
Value:
262144                                                                

CUPS_PRINTER_IMPLICIT

Type:
int
Value:
65536                                                                 

CUPS_PRINTER_LARGE

Type:
int
Value:
16384                                                                 

CUPS_PRINTER_LOCAL

Type:
int
Value:
0                                                                     

CUPS_PRINTER_MEDIUM

Type:
int
Value:
8192                                                                  

CUPS_PRINTER_NOT_SHARED

Type:
int
Value:
2097152                                                               

CUPS_PRINTER_OPTIONS

Type:
int
Value:
458748                                                                

CUPS_PRINTER_PUNCH

Type:
int
Value:
256                                                                   

CUPS_PRINTER_REJECTING

Type:
int
Value:
524288                                                                

CUPS_PRINTER_REMOTE

Type:
int
Value:
2                                                                     

CUPS_PRINTER_SMALL

Type:
int
Value:
4096                                                                  

CUPS_PRINTER_SORT

Type:
int
Value:
2048                                                                  

CUPS_PRINTER_STAPLE

Type:
int
Value:
32                                                                    

CUPS_PRINTER_VARIABLE

Type:
int
Value:
32768                                                                 

CUPS_SERVER_DEBUG_LOGGING

Type:
str
Value:
'_debug_logging'                                                       

CUPS_SERVER_REMOTE_ADMIN

Type:
str
Value:
'_remote_admin'                                                        

CUPS_SERVER_REMOTE_ANY

Type:
str
Value:
'_remote_any'                                                          

CUPS_SERVER_REMOTE_PRINTERS

Type:
str
Value:
'_remote_printers'                                                     

CUPS_SERVER_SHARE_PRINTERS

Type:
str
Value:
'_share_printers'                                                      

CUPS_SERVER_USER_CANCEL_ANY

Type:
str
Value:
'_user_cancel_any'                                                     

HTTP_BAD_REQUEST

Type:
int
Value:
400                                                                   

HTTP_ENCRYPT_ALWAYS

Type:
int
Value:
3                                                                     

HTTP_ENCRYPT_IF_REQUESTED

Type:
int
Value:
0                                                                     

HTTP_ENCRYPT_NEVER

Type:
int
Value:
1                                                                     

HTTP_ENCRYPT_REQUIRED

Type:
int
Value:
2                                                                     

HTTP_ERROR

Type:
int
Value:
-1                                                                    

HTTP_FORBIDDEN

Type:
int
Value:
403                                                                   

HTTP_NOT_FOUND

Type:
int
Value:
404                                                                   

HTTP_OK

Type:
int
Value:
200                                                                   

HTTP_REQUEST_TIMEOUT

Type:
int
Value:
408                                                                   

HTTP_SERVER_ERROR

Type:
int
Value:
500                                                                   

HTTP_UNAUTHORIZED

Type:
int
Value:
401                                                                   

HTTP_UPGRADE_REQUIRED

Type:
int
Value:
426                                                                   

IPP_ATTRIBUTES

Type:
int
Value:
1035                                                                  

IPP_ATTRIBUTES_NOT_SETTABLE

Type:
int
Value:
1043                                                                  

IPP_BAD_REQUEST

Type:
int
Value:
1024                                                                  

IPP_CHARSET

Type:
int
Value:
1037                                                                  

IPP_COMPRESSION_ERROR

Type:
int
Value:
1040                                                                  

IPP_COMPRESSION_NOT_SUPPORTED

Type:
int
Value:
1039                                                                  

IPP_CONFLICT

Type:
int
Value:
1038                                                                  

IPP_DEVICE_ERROR

Type:
int
Value:
1284                                                                  

IPP_DOCUMENT_ACCESS_ERROR

Type:
int
Value:
1042                                                                  

IPP_DOCUMENT_FORMAT

Type:
int
Value:
1034                                                                  

IPP_DOCUMENT_FORMAT_ERROR

Type:
int
Value:
1041                                                                  

IPP_ERROR_JOB_CANCELLED

Type:
int
Value:
1288                                                                  

IPP_FINISHINGS_BALE

Type:
int
Value:
12                                                                    

IPP_FINISHINGS_BIND

Type:
int
Value:
7                                                                     

IPP_FINISHINGS_BIND_BOTTOM

Type:
int
Value:
53                                                                    

IPP_FINISHINGS_BIND_LEFT

Type:
int
Value:
50                                                                    

IPP_FINISHINGS_BIND_RIGHT

Type:
int
Value:
52                                                                    

IPP_FINISHINGS_BIND_TOP

Type:
int
Value:
51                                                                    

IPP_FINISHINGS_BOOKLET_MAKER

Type:
int
Value:
13                                                                    

IPP_FINISHINGS_COVER

Type:
int
Value:
6                                                                     

IPP_FINISHINGS_EDGE_STITCH

Type:
int
Value:
9                                                                     

IPP_FINISHINGS_EDGE_STITCH_BOTTOM

Type:
int
Value:
27                                                                    

IPP_FINISHINGS_EDGE_STITCH_LEFT

Type:
int
Value:
24                                                                    

IPP_FINISHINGS_EDGE_STITCH_RIGHT

Type:
int
Value:
26                                                                    

IPP_FINISHINGS_EDGE_STITCH_TOP

Type:
int
Value:
25                                                                    

IPP_FINISHINGS_FOLD

Type:
int
Value:
10                                                                    

IPP_FINISHINGS_JOB_OFFSET

Type:
int
Value:
14                                                                    

IPP_FINISHINGS_NONE

Type:
int
Value:
3                                                                     

IPP_FINISHINGS_PUNCH

Type:
int
Value:
5                                                                     

IPP_FINISHINGS_SADDLE_STITCH

Type:
int
Value:
8                                                                     

IPP_FINISHINGS_STAPLE

Type:
int
Value:
4                                                                     

IPP_FINISHINGS_STAPLE_BOTTOM_LEFT

Type:
int
Value:
21                                                                    

IPP_FINISHINGS_STAPLE_BOTTOM_RIGHT

Type:
int
Value:
23                                                                    

IPP_FINISHINGS_STAPLE_DUAL_BOTTOM

Type:
int
Value:
31                                                                    

IPP_FINISHINGS_STAPLE_DUAL_LEFT

Type:
int
Value:
28                                                                    

IPP_FINISHINGS_STAPLE_DUAL_RIGHT

Type:
int
Value:
30                                                                    

IPP_FINISHINGS_STAPLE_DUAL_TOP

Type:
int
Value:
29                                                                    

IPP_FINISHINGS_STAPLE_TOP_LEFT

Type:
int
Value:
20                                                                    

IPP_FINISHINGS_STAPLE_TOP_RIGHT

Type:
int
Value:
22                                                                    

IPP_FINISHINGS_TRIM

Type:
int
Value:
11                                                                    

IPP_FORBIDDEN

Type:
int
Value:
1025                                                                  

IPP_GONE

Type:
int
Value:
1031                                                                  

IPP_IGNORED_ALL_NOTIFICATIONS

Type:
int
Value:
1046                                                                  

IPP_IGNORED_ALL_SUBSCRIPTIONS

Type:
int
Value:
1044                                                                  

IPP_INTERNAL_ERROR

Type:
int
Value:
1280                                                                  

IPP_JOB_ABORTED

Type:
int
Value:
8                                                                     

IPP_JOB_CANCELED

Type:
int
Value:
7                                                                     

IPP_JOB_COMPLETED

Type:
int
Value:
9                                                                     

IPP_JOB_HELD

Type:
int
Value:
4                                                                     

IPP_JOB_PENDING

Type:
int
Value:
3                                                                     

IPP_JOB_PROCESSING

Type:
int
Value:
5                                                                     

IPP_JOB_STOPPED

Type:
int
Value:
6                                                                     

IPP_MAX_NAME

Type:
int
Value:
256                                                                   

IPP_MULTIPLE_JOBS_NOT_SUPPORTED

Type:
int
Value:
1289                                                                  

IPP_NOT_ACCEPTING

Type:
int
Value:
1286                                                                  

IPP_NOT_AUTHENTICATED

Type:
int
Value:
1026                                                                  

IPP_NOT_AUTHORIZED

Type:
int
Value:
1027                                                                  

IPP_NOT_FOUND

Type:
int
Value:
1030                                                                  

IPP_NOT_POSSIBLE

Type:
int
Value:
1028                                                                  

IPP_OK

Type:
int
Value:
0                                                                     

IPP_OK_BUT_CANCEL_SUBSCRIPTION

Type:
int
Value:
6                                                                     

IPP_OK_CONFLICT

Type:
int
Value:
2                                                                     

IPP_OK_EVENTS_COMPLETE

Type:
int
Value:
7                                                                     

IPP_OK_IGNORED_NOTIFICATIONS

Type:
int
Value:
4                                                                     

IPP_OK_IGNORED_SUBSCRIPTIONS

Type:
int
Value:
3                                                                     

IPP_OK_SUBST

Type:
int
Value:
1                                                                     

IPP_OK_TOO_MANY_EVENTS

Type:
int
Value:
5                                                                     

IPP_OPERATION_NOT_SUPPORTED

Type:
int
Value:
1281                                                                  

IPP_PRINT_SUPPORT_FILE_NOT_FOUND

Type:
int
Value:
1047                                                                  

IPP_PRINTER_BUSY

Type:
int
Value:
1287                                                                  

IPP_PRINTER_IDLE

Type:
int
Value:
3                                                                     

IPP_PRINTER_IS_DEACTIVATED

Type:
int
Value:
1290                                                                  

IPP_PRINTER_PROCESSING

Type:
int
Value:
4                                                                     

IPP_PRINTER_STOPPED

Type:
int
Value:
5                                                                     

IPP_REDIRECTION_OTHER_SITE

Type:
int
Value:
512                                                                   

IPP_REQUEST_ENTITY

Type:
int
Value:
1032                                                                  

IPP_REQUEST_VALUE

Type:
int
Value:
1033                                                                  

IPP_SERVICE_UNAVAILABLE

Type:
int
Value:
1282                                                                  

IPP_TEMPORARY_ERROR

Type:
int
Value:
1285                                                                  

IPP_TIMEOUT

Type:
int
Value:
1029                                                                  

IPP_TOO_MANY_SUBSCRIPTIONS

Type:
int
Value:
1045                                                                  

IPP_URI_SCHEME

Type:
int
Value:
1036                                                                  

IPP_VERSION_NOT_SUPPORTED

Type:
int
Value:
1283                                                                  

PPD_UI_BOOLEAN

Type:
int
Value:
0                                                                     

PPD_UI_PICKMANY

Type:
int
Value:
2                                                                     

PPD_UI_PICKONE

Type:
int
Value:
1                                                                     

Generated by Epydoc 2.1 on Mon Oct 15 07:41:44 2007 http://epydoc.sf.net