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

Module cups

Classes [hide private]
  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.
  HTTPError
This exception is raised when an HTTP problem has occurred.
  IPPError
This exception is raised when an IPP error has occurred.
  Option
A PPD option.
  PPD
A PPD file.
Functions [hide private]
integer
getEncryption()
Get encryption policy.
integer
getPort()
Returns: IPP port to connect to.
string
getServer()
Returns: server to connect to.
string
getUser()
Returns: 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.
Variables [hide private]
  CUPS_PRINTER_AUTHENTICATED = 4194304
  CUPS_PRINTER_BIND = 1024
  CUPS_PRINTER_BW = 4
  CUPS_PRINTER_CLASS = 1
  CUPS_PRINTER_COLLATE = 128
  CUPS_PRINTER_COLOR = 8
  CUPS_PRINTER_COMMANDS = 8388608
  CUPS_PRINTER_COPIES = 64
  CUPS_PRINTER_COVER = 512
  CUPS_PRINTER_DEFAULT = 131072
  CUPS_PRINTER_DELETE = 1048576
  CUPS_PRINTER_DISCOVERED = 16777216
  CUPS_PRINTER_DUPLEX = 16
  CUPS_PRINTER_FAX = 262144
  CUPS_PRINTER_IMPLICIT = 65536
  CUPS_PRINTER_LARGE = 16384
  CUPS_PRINTER_LOCAL = 0
  CUPS_PRINTER_MEDIUM = 8192
  CUPS_PRINTER_NOT_SHARED = 2097152
  CUPS_PRINTER_OPTIONS = 458748
  CUPS_PRINTER_PUNCH = 256
  CUPS_PRINTER_REJECTING = 524288
  CUPS_PRINTER_REMOTE = 2
  CUPS_PRINTER_SMALL = 4096
  CUPS_PRINTER_SORT = 2048
  CUPS_PRINTER_STAPLE = 32
  CUPS_PRINTER_VARIABLE = 32768
  CUPS_SERVER_DEBUG_LOGGING = '_debug_logging'
  CUPS_SERVER_REMOTE_ADMIN = '_remote_admin'
  CUPS_SERVER_REMOTE_ANY = '_remote_any'
  CUPS_SERVER_REMOTE_PRINTERS = '_remote_printers'
  CUPS_SERVER_SHARE_PRINTERS = '_share_printers'
  CUPS_SERVER_USER_CANCEL_ANY = '_user_cancel_any'
  HTTP_BAD_REQUEST = 400
  HTTP_ENCRYPT_ALWAYS = 3
  HTTP_ENCRYPT_IF_REQUESTED = 0
  HTTP_ENCRYPT_NEVER = 1
  HTTP_ENCRYPT_REQUIRED = 2
  HTTP_ERROR = -1
  HTTP_FORBIDDEN = 403
  HTTP_NOT_FOUND = 404
  HTTP_OK = 200
  HTTP_REQUEST_TIMEOUT = 408
  HTTP_SERVER_ERROR = 500
  HTTP_UNAUTHORIZED = 401
  HTTP_UPGRADE_REQUIRED = 426
  IPP_ATTRIBUTES = 1035
  IPP_ATTRIBUTES_NOT_SETTABLE = 1043
  IPP_BAD_REQUEST = 1024
  IPP_CHARSET = 1037
  IPP_COMPRESSION_ERROR = 1040
  IPP_COMPRESSION_NOT_SUPPORTED = 1039
  IPP_CONFLICT = 1038
  IPP_DEVICE_ERROR = 1284
  IPP_DOCUMENT_ACCESS_ERROR = 1042
  IPP_DOCUMENT_FORMAT = 1034
  IPP_DOCUMENT_FORMAT_ERROR = 1041
  IPP_ERROR_JOB_CANCELLED = 1288
  IPP_FINISHINGS_BALE = 12
  IPP_FINISHINGS_BIND = 7
  IPP_FINISHINGS_BIND_BOTTOM = 53
  IPP_FINISHINGS_BIND_LEFT = 50
  IPP_FINISHINGS_BIND_RIGHT = 52
  IPP_FINISHINGS_BIND_TOP = 51
  IPP_FINISHINGS_BOOKLET_MAKER = 13
  IPP_FINISHINGS_COVER = 6
  IPP_FINISHINGS_EDGE_STITCH = 9
  IPP_FINISHINGS_EDGE_STITCH_BOTTOM = 27
  IPP_FINISHINGS_EDGE_STITCH_LEFT = 24
  IPP_FINISHINGS_EDGE_STITCH_RIGHT = 26
  IPP_FINISHINGS_EDGE_STITCH_TOP = 25
  IPP_FINISHINGS_FOLD = 10
  IPP_FINISHINGS_JOB_OFFSET = 14
  IPP_FINISHINGS_NONE = 3
  IPP_FINISHINGS_PUNCH = 5
  IPP_FINISHINGS_SADDLE_STITCH = 8
  IPP_FINISHINGS_STAPLE = 4
  IPP_FINISHINGS_STAPLE_BOTTOM_LEFT = 21
  IPP_FINISHINGS_STAPLE_BOTTOM_RIGHT = 23
  IPP_FINISHINGS_STAPLE_DUAL_BOTTOM = 31
  IPP_FINISHINGS_STAPLE_DUAL_LEFT = 28
  IPP_FINISHINGS_STAPLE_DUAL_RIGHT = 30
  IPP_FINISHINGS_STAPLE_DUAL_TOP = 29
  IPP_FINISHINGS_STAPLE_TOP_LEFT = 20
  IPP_FINISHINGS_STAPLE_TOP_RIGHT = 22
  IPP_FINISHINGS_TRIM = 11
  IPP_FORBIDDEN = 1025
  IPP_GONE = 1031
  IPP_IGNORED_ALL_NOTIFICATIONS = 1046
  IPP_IGNORED_ALL_SUBSCRIPTIONS = 1044
  IPP_INTERNAL_ERROR = 1280
  IPP_JOB_ABORTED = 8
  IPP_JOB_CANCELED = 7
  IPP_JOB_COMPLETED = 9
  IPP_JOB_HELD = 4
  IPP_JOB_PENDING = 3
  IPP_JOB_PROCESSING = 5
  IPP_JOB_STOPPED = 6
  IPP_MAX_NAME = 256
  IPP_MULTIPLE_JOBS_NOT_SUPPORTED = 1289
  IPP_NOT_ACCEPTING = 1286
  IPP_NOT_AUTHENTICATED = 1026
  IPP_NOT_AUTHORIZED = 1027
  IPP_NOT_FOUND = 1030
  IPP_NOT_POSSIBLE = 1028
  IPP_OK = 0
  IPP_OK_BUT_CANCEL_SUBSCRIPTION = 6
  IPP_OK_CONFLICT = 2
  IPP_OK_EVENTS_COMPLETE = 7
  IPP_OK_IGNORED_NOTIFICATIONS = 4
  IPP_OK_IGNORED_SUBSCRIPTIONS = 3
  IPP_OK_SUBST = 1
  IPP_OK_TOO_MANY_EVENTS = 5
  IPP_OPERATION_NOT_SUPPORTED = 1281
  IPP_PRINTER_BUSY = 1287
  IPP_PRINTER_IDLE = 3
  IPP_PRINTER_IS_DEACTIVATED = 1290
  IPP_PRINTER_PROCESSING = 4
  IPP_PRINTER_STOPPED = 5
  IPP_PRINT_SUPPORT_FILE_NOT_FOUND = 1047
  IPP_REDIRECTION_OTHER_SITE = 512
  IPP_REQUEST_ENTITY = 1032
  IPP_REQUEST_VALUE = 1033
  IPP_SERVICE_UNAVAILABLE = 1282
  IPP_TEMPORARY_ERROR = 1285
  IPP_TIMEOUT = 1029
  IPP_TOO_MANY_SUBSCRIPTIONS = 1045
  IPP_URI_SCHEME = 1036
  IPP_VERSION_NOT_SUPPORTED = 1283
  PPD_UI_BOOLEAN = 0
  PPD_UI_PICKMANY = 2
  PPD_UI_PICKONE = 1
  __package__ = None
Function Details [hide private]

getEncryption()

 

Get encryption policy.

Returns: integer

See Also: setEncryption

getPort()

 
Returns: integer
IPP port to connect to.

getServer()

 
Returns: string
server to connect to.

getUser()

 
Returns: string
user to connect as.

modelSort(s1, s2)

 

Sort two model strings.

Parameters:
  • s1 (string) - first string
  • s2 (string) - second string
Returns: integer
strcmp-style comparision result

require(version)

 

Require pycups version.

Parameters:
  • version (string) - minimum pycups version required
Returns: None
Raises:
  • RuntimeError - requirement not met

setEncryption(policy)

 

Set encryption policy.

Parameters:
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 (callable object) - callback function
Returns: None

setPort(port)

 

Set IPP port to connect to.

Parameters:
  • port (integer) - IPP port
Returns: None

setServer(server)

 

Set server to connect to.

Parameters:
  • server (string) - server hostname
Returns: None

setUser(user)

 

Set user to connect as.

Parameters:
  • user (string) - username
Returns: None