Constants

class pypdf.constants.AnnotationFlag(value, names=None, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: IntFlag

See 12.5.3 “Annotation Flags”.

INVISIBLE = 1
HIDDEN = 2
PRINT = 4
NO_ZOOM = 8
NO_ROTATE = 16
NO_VIEW = 32
READ_ONLY = 64
LOCKED = 128
TOGGLE_NO_VIEW = 256
LOCKED_CONTENTS = 512
class pypdf.constants.ImageType(value, names=None, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: IntFlag

NONE = 0
XOBJECT_IMAGES = 1
INLINE_IMAGES = 2
DRAWING_IMAGES = 4
ALL = 7
IMAGES = 7
class pypdf.constants.PageLabelStyle[source]

Bases: object

Table 8.10 in the 1.7 reference.

DECIMAL = '/D'
LOWERCASE_ROMAN = '/r'
UPPERCASE_ROMAN = '/R'
LOWERCASE_LETTER = '/a'
UPPERCASE_LETTER = '/A'
class pypdf.constants.UserAccessPermissions(value, names=None, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: IntFlag

TABLE 3.20 User access permissions.

R1 = 1
R2 = 2
PRINT = 4
MODIFY = 8
EXTRACT = 16
ADD_OR_MODIFY = 32
R7 = 64
R8 = 128
FILL_FORM_FIELDS = 256
EXTRACT_TEXT_AND_GRAPHICS = 512
ASSEMBLE_DOC = 1024
PRINT_TO_REPRESENTATION = 2048
R13 = 4096
R14 = 8192
R15 = 16384
R16 = 32768
R17 = 65536
R18 = 131072
R19 = 262144
R20 = 524288
R21 = 1048576
R22 = 2097152
R23 = 4194304
R24 = 8388608
R25 = 16777216
R26 = 33554432
R27 = 67108864
R28 = 134217728
R29 = 268435456
R30 = 536870912
R31 = 1073741824
R32 = 2147483648
to_dict() Dict[str, bool][source]

Convert the given flag value to a corresponding verbose name mapping.

classmethod from_dict(value: Dict[str, bool]) UserAccessPermissions[source]

Convert the verbose name mapping to the corresponding flag value.

classmethod all() UserAccessPermissions[source]