Scroll to navigation

SRC(1) psd-tools SRC(1)

NAME

src - src Documentation

psd-tools is a Python package for working with Adobe Photoshop PSD files as described in specification.

INSTALLATION

Use pip to install the package:

pip install psd-tools


NOTE:

In order to extract images from 32bit PSD files PIL/Pillow must be built with LITTLECMS or LITTLECMS2 support (apt-get install liblcms2-2 or brew install little-cms2)


GETTING STARTED

from psd_tools import PSDImage
psd = PSDImage.open('example.psd')
psd.composite().save('example.png')
for layer in psd:


    print(layer)


    image = layer.composite()


Check out the Usage documentation for more examples.

Usage

Command line

The package provides command line tools to handle a PSD document:

psd-tools export <input_file> <output_file> [options]
psd-tools show <input_file> [options]
psd-tools debug <input_file> [options]
psd-tools -h | --help
psd-tools --version


Example:

psd-tools show example.psd  # Show the file content
psd-tools export example.psd example.png  # Export as PNG
psd-tools export example.psd[0] example-0.png  # Export layer as PNG


Working with PSD document

psd_tools.api package provides the user-friendly API to work with PSD files. PSDImage represents a PSD file.

Open an image:

from psd_tools import PSDImage
psd = PSDImage.open('my_image.psd')


Most of the data structure in the psd-tools suppports pretty printing in IPython environment.

In [1]: PSDImage.open('example.psd')
Out[1]:
PSDImage(mode=RGB size=101x55 depth=8 channels=3)


  [0] PixelLayer('Background' size=101x55)


  [1] PixelLayer('Layer 1' size=85x46)


Internal layers are accessible by iterator or indexing:

for layer in psd:


    print(layer)


    if layer.is_group():


        for child in layer:


            print(child)
child = psd[0][0]


NOTE:

The iteration order is from background to foreground, which is reversed from version prior to 1.7.x. Use reversed(list(psd)) to iterate from foreground to background.


The opened PSD file can be saved:

psd.save('output.psd')


Working with Layers

There are various layer kinds in Photoshop.

The most basic layer type is PixelLayer:

print(layer.name)
layer.kind == 'pixel'


Some of the layer attributes are editable, such as a layer name:

layer.name = 'Updated layer 1'


NOTE:

Currently, the package does not support adding or removing of a layer.


Group has internal layers:

for layer in group:


    print(layer)
first_layer = group[0]


TypeLayer is a layer with texts:

print(layer.text)


ShapeLayer draws a vector shape, and the shape information is stored in vector_mask and origination property. Other layers can also have shape information as a mask:

print(layer.vector_mask)
for shape in layer.origination:


    print(shape)


SmartObjectLayer embeds or links an external file for non-destructive editing. The file content is accessible via smart_object property:

import io
if layer.smart_object.filetype in ('jpg', 'png'):


    image = Image.open(io.BytesIO(layer.smart_object.data))


SolidColorFill, PatternFill, and GradientFill are fill layers that paint the entire region if there is no associated mask. Sub-classes of AdjustmentLayer represents layer adjustment applied to the composed image. See Adjustment layers.

Exporting data to PIL

Export the entire document as PIL.Image:

image = psd.composite()
image.save('exported.png')


Export a single layer including masks and clipping layers:

image = layer.composite()


Export layer and mask separately without composition:

image = layer.topil()
mask = layer.mask.topil()


To composite specific layers, such as layers except for texts, use layer_filter option:

image = psd.composite(


    layer_filter=lambda layer: layer.is_visible() and layer.kind != 'type')


Note that most of the layer effects and adjustment layers are not supported. The compositing result may look different from Photoshop.

Exporting data to NumPy

PSDImage or layers can be exported to NumPy array by numpy() method:

image = psd.numpy()
layer_image = layer.numpy()


Migrating to 1.9

psd-tools 1.9 switches to NumPy based compositing.

version 1.8.x:

psd = PSDImage.open(filename)
image = psd.compose()
layer = psd[0]
layer_image = layer.compose()


version 1.9.x:

psd = PSDImage.open(filename)
image = psd.composite()
layer = psd[0]
layer_image = layer.composite()


NumPy array API is introduced:

image = psd.numpy()
layer_image = layer.numpy()


Migrating to 1.8

There are major API changes in version 1.8.x.

NOTE:

In version 1.8.0 - 1.8.7, the package name was psd_tools2.


PSDImage

File open method is changed from load to open().

version 1.7.x:

psd = PSDImage.load(filename)
with open(filename, 'rb') as f:


    psd = PSDImage.from_stream(f)


version 1.8.x:

psd = PSDImage.open(filename)
with open(filename, 'rb') as f:


    psd = PSDImage.open(f)


Layers

Children of PSDImage or Group is directly accessible by iterator or indexing.

version 1.7.x:

for layer in group.layers:


    print(layer)
first_child = group.layers[0]


version 1.8.x:

for layer in group:


    print(layer)
first_child = group[0]


In version 1.8.x, the order of layers is reversed to reflect that the index should not change when a new layer is added on top.

PIL export

Primary PIL export method is compose().

version 1.7.x:

image = psd.as_PIL()
layer_image = compose(layer)
raw_layer_image = layer.as_PIL()


version 1.8.x:

image = psd.compose()
layer_image = layer.compose()
raw_layer_image = layer.topil()


Low-level data structure

Data structures are completely rewritten to support writing functionality. See psd_tools.psd subpackage.

version 1.7.x:

psd.decoded_data


version 1.8.x:

psd._record


Drop pymaging support

Pymaging support is dropped.

Contributing

Development happens at github: bug tracker. Feel free to submit bug reports or pull requests. Attaching an erroneous PSD file makes the debugging process faster. Such PSD file might be added to the test suite.

The license is MIT.

Package design

The package consists of two major subpackages:

1.
psd_tools.psd: subpackage that reads/writes low-level binary
structure of the PSD/PSB file. The core data structures are built around attrs class that all implement read and write methods. Each data object tries to resemble the structure described in the specification. Although documented, the specification is far from complete and some are even inaccurate. When psd-tools finds unknown data structure, the package keeps such data as bytes in the parsed result.


2.
easy-to-use methods that manipulate low-level psd_tools.psd data structures.


Testing

In order to run tests, make sure PIL/Pillow is built with LittleCMS or LittleCMS2 support. For example, on Ubuntu, install the following packages:

apt-get install liblcms2-dev libjpeg-dev libfreetype6-dev zlib1g-dev


Then install psd-tools with the following command:

pip install -e .[dev]


Finally, run tests with pytest:

pytest


Documentation

Install Sphinx to generate documents:

pip install sphinx sphinx_rtd_theme


Once installed, use Makefile:

make docs


Acknowledgments

Great thanks to all the contributors.

FEATURES

Supported:

  • Read and write of the low-level PSD/PSB file structure
  • Raw layer image export in NumPy and PIL format

Limited support:

  • Composition of basic pixel-based layers
  • Composition of fill layer effects
  • Vector masks
  • Editing of some layer attributes such as layer name
  • Blending modes except for dissolve
  • Drawing of bezier curves

Not supported:

  • Editing of layer structure, such as adding or removing a layer
  • Composition of adjustment layers
  • Composition of many layer effects
  • Font rendering

psd_tools

See Usage for examples.

PSDImage

Photoshop PSD/PSB file object.

The low-level data structure is accessible at PSDImage._record.

Example:

from psd_tools import PSDImage
psd = PSDImage.open('example.psd')
image = psd.compose()
for layer in psd:


    layer_image = layer.compose()


Minimal bounding box that contains all the visible layers.

Use viewbox to get viewport bounding box. When the psd is empty, bbox is equal to the canvas bounding box.

(left, top, right, bottom) tuple.


Bottom coordinate.
int


Number of color channels.
int


Document color mode, such as 'RGB' or 'GRAYSCALE'. See ColorMode.
ColorMode


Set the compositing and layer organization compatibility mode. Writable.
CompatibilityMode


Deprecated, use composite().

Compose the PSD image.

bbox -- Viewport tuple (left, top, right, bottom).
PIL.Image, or None if there is no pixel.


Composite the PSD image.
  • viewport -- Viewport bounding box specified by (x1, y1, x2, y2) tuple. Default is the viewbox of the PSD.
  • ignore_preview -- Boolean flag to whether skip compositing when a pre-composited preview is available.
  • force -- Boolean flag to force vector drawing.
  • color -- Backdrop color specified by scalar or tuple of scalar. The color value should be in [0.0, 1.0]. For example, (1., 0., 0.) specifies red in RGB color mode.
  • alpha -- Backdrop alpha in [0.0, 1.0].
  • layer_filter -- Callable that takes a layer as argument and returns whether if the layer is composited. Default is is_visible().

PIL.Image.


Pixel depth bits.
int


Return a generator to iterate over all descendant layers.

Example:

# Iterate over all layers
for layer in psd.descendants():


    print(layer)
# Iterate over all layers in reverse order
for layer in reversed(list(psd.descendants())):


    print(layer)


include_clip -- include clipping layers.


Create a new PSD document from PIL Image.
  • image -- PIL Image object.
  • compression -- ImageData compression option. See Compression.

A PSDImage object.


Returns if the document has real merged data. When True, topil() returns pre-composed data.

True if the PSDImage has a thumbnail resource.

Document height.
int


Document image resources. ImageResources is a dict-like structure that keeps various document settings.

See psd_tools.constants.Resource for available keys.

ImageResources

Example:

from psd_tools.constants import Resource
version_info = psd.image_resources.get_data(Resource.VERSION_INFO)
slices = psd.image_resources.get_data(Resource.SLICES)


Image resources contain an ICC profile. The following shows how to export a PNG file with embedded ICC profile:

from psd_tools.constants import Resource
icc_profile = psd.image_resources.get_data(Resource.ICC_PROFILE)
image = psd.compose(apply_icc=False)
image.save('output.png', icc_profile=icc_profile)



Return True if the layer is a group.
bool


Returns visibility of the element.
bool


Kind.
'psdimage'


Left coordinate.
0


Element name.
'Root'


Create a new PSD document.
  • mode -- The color mode to use for the new image.
  • size -- A tuple containing (width, height) in pixels.
  • color -- What color to use for the image. Default is black.

A PSDImage object.


Get NumPy array of the layer.
channel -- Which channel to return, can be 'color', 'shape', 'alpha', or 'mask'. Default is 'color+alpha'.
numpy.ndarray


(left, top) tuple.
tuple


Open a PSD document.
  • fp -- filename or file-like object.
  • encoding -- charset encoding of the pascal string within the file, default 'macroman'. Some psd files need explicit encoding option.

A PSDImage object.


Parent of this layer.

Right coordinate.
int


Save the PSD file.
  • fp -- filename or file-like object.
  • encoding -- charset encoding of the pascal string within the file, default 'macroman'.
  • mode -- file open mode, default 'wb'.



(width, height) tuple.
tuple


Document tagged blocks that is a dict-like container of settings.

See psd_tools.constants.Tag for available keys.

TaggedBlocks or None.

Example:

from psd_tools.constants import Tag
patterns = psd.tagged_blocks.get_data(Tag.PATTERNS1)



Returns a thumbnail image in PIL.Image. When the file does not contain an embedded thumbnail image, returns None.

Top coordinate.
0


Get PIL Image.
  • channel -- Which channel to return; e.g., 0 for 'R' channel in RGB image. See ChannelID. When None, the method returns all the channels supported by PIL modes.
  • apply_icc -- Whether to apply ICC profile conversion to sRGB.

PIL.Image, or None if the composed image is not available.


Document version. PSD file is 1, and PSB file is 2.
int


Return bounding box of the viewport.
(left, top, right, bottom) tuple.


Visibility.
True


Document width.
int



psd_tools.api.adjustments

Adjustment and fill layers.

Example:

if layer.kind == 'brightnesscontrast':


    print(layer.brightness)
if layer.kind == 'gradientfill':


    print(layer.gradient_kind)


Fill layers

Fill layers are similar to ShapeLayer except that the layer might not have an associated vector mask. The layer therefore expands the entire canvas of the PSD document.

Fill layers all inherit from FillLayer.

Example:

if isinstance(layer, psd_tools.layers.FillLayer):


    image = layer.compose()


SolidColorFill

Solid color fill.
(left, top, right, bottom) tuple.

Blend mode of this layer. Writable.

Example:

from psd_tools.constants import BlendMode
if layer.blend_mode == BlendMode.NORMAL:


    layer.blend_mode = BlendMode.SCREEN


BlendMode.


Bottom coordinate.
int


Clip layers associated with this layer.

To compose clipping layers:

from psd_tools import compose
clip_mask = compose(layer.clip_layers)


list of layers


Clipping flag for this layer. Writable.
bool


Deprecated, use composite().

Compose layer and masks (mask, vector mask, and clipping layers).

Note that the resulting image size is not necessarily equal to the layer size due to different mask dimensions. The offset of the composed image is stored at .info['offset'] attribute of PIL.Image.

bbox -- Viewport bounding box specified by (x1, y1, x2, y2) tuple.
PIL.Image, or None if the layer has no pixel.


Composite layer and masks (mask, vector mask, and clipping layers).
  • viewport -- Viewport bounding box specified by (x1, y1, x2, y2) tuple. Default is the layer's bbox.
  • force -- Boolean flag to force vector drawing.
  • color -- Backdrop color specified by scalar or tuple of scalar. The color value should be in [0.0, 1.0]. For example, (1., 0., 0.) specifies red in RGB color mode.
  • alpha -- Backdrop alpha in [0.0, 1.0].
  • layer_filter -- Callable that takes a layer as argument and returns whether if the layer is composited. Default is is_visible().

PIL.Image.


Color in Descriptor(RGB).

Layer effects.
Effects


Returns True if the layer has associated clipping.
bool


Returns True if the layer has effects.
bool


Returns True if the layer has a mask.
bool


Returns True if the layer has live shape properties.
bool


Returns True if the layer has associated pixels. When this is True, topil method returns PIL.Image.
bool


Returns True if the shape has a stroke.

Returns True if the layer has a vector mask.
bool


Height of the layer.
int


Return True if the layer is a group.
bool


Layer visibility. Takes group visibility in account.
bool


Kind of this layer, such as group, pixel, shape, type, smartobject, or psdimage. Class name without layer suffix.
str


Layer ID.
int layer id. if the layer is not assigned an id, -1.


Left coordinate. Writable.
int


Returns mask associated with this layer.
Mask or None


Layer name. Writable.
str


Get NumPy array of the layer.
channel -- Which channel to return, can be 'color', 'shape', 'alpha', or 'mask'. Default is 'color+alpha'.
numpy.ndarray or None if there is no pixel.


(left, top) tuple. Writable.
tuple


Opacity of this layer in [0, 255] range. Writable.
int


Property for a list of live shapes or a line.

Some of the vector masks have associated live shape properties, that are Photoshop feature to handle primitive shapes such as a rectangle, an ellipse, or a line. Vector masks without live shape properties are plain path objects.

See psd_tools.api.shape.

List of Invalidated, Rectangle, RoundedRectangle, Ellipse, or Line.


Parent of this layer.

Right coordinate.
int


(width, height) tuple.
tuple


Property for strokes.

Layer tagged blocks that is a dict-like container of settings.

See psd_tools.constants.Tag for available keys.

TaggedBlocks or None.

Example:

from psd_tools.constants import Tag
metadata = layer.tagged_blocks.get_data(Tag.METADATA_SETTING)



Top coordinate. Writable.
int


Get PIL Image of the layer.
  • channel -- Which channel to return; e.g., 0 for 'R' channel in RGB image. See ChannelID. When None, the method returns all the channels supported by PIL modes.
  • apply_icc -- Whether to apply ICC profile conversion to sRGB.

PIL.Image, or None if the layer has no pixels.

Example:

from psd_tools.constants import ChannelID
image = layer.topil()
red = layer.topil(ChannelID.CHANNEL_0)
alpha = layer.topil(ChannelID.TRANSPARENCY_MASK)


NOTE:

Not all of the PSD image modes are supported in PIL.Image. For example, 'CMYK' mode cannot include alpha channel in PIL. In this case, topil drops alpha channel.



Returns vector mask associated with this layer.
VectorMask or None


Layer visibility. Doesn't take group visibility in account. Writable.
bool


Width of the layer.
int



PatternFill

Pattern fill.
(left, top, right, bottom) tuple.

Blend mode of this layer. Writable.

Example:

from psd_tools.constants import BlendMode
if layer.blend_mode == BlendMode.NORMAL:


    layer.blend_mode = BlendMode.SCREEN


BlendMode.


Bottom coordinate.
int


Clip layers associated with this layer.

To compose clipping layers:

from psd_tools import compose
clip_mask = compose(layer.clip_layers)


list of layers


Clipping flag for this layer. Writable.
bool


Deprecated, use composite().

Compose layer and masks (mask, vector mask, and clipping layers).

Note that the resulting image size is not necessarily equal to the layer size due to different mask dimensions. The offset of the composed image is stored at .info['offset'] attribute of PIL.Image.

bbox -- Viewport bounding box specified by (x1, y1, x2, y2) tuple.
PIL.Image, or None if the layer has no pixel.


Composite layer and masks (mask, vector mask, and clipping layers).
  • viewport -- Viewport bounding box specified by (x1, y1, x2, y2) tuple. Default is the layer's bbox.
  • force -- Boolean flag to force vector drawing.
  • color -- Backdrop color specified by scalar or tuple of scalar. The color value should be in [0.0, 1.0]. For example, (1., 0., 0.) specifies red in RGB color mode.
  • alpha -- Backdrop alpha in [0.0, 1.0].
  • layer_filter -- Callable that takes a layer as argument and returns whether if the layer is composited. Default is is_visible().

PIL.Image.


Pattern in Descriptor(PATTERN).

Layer effects.
Effects


Returns True if the layer has associated clipping.
bool


Returns True if the layer has effects.
bool


Returns True if the layer has a mask.
bool


Returns True if the layer has live shape properties.
bool


Returns True if the layer has associated pixels. When this is True, topil method returns PIL.Image.
bool


Returns True if the shape has a stroke.

Returns True if the layer has a vector mask.
bool


Height of the layer.
int


Return True if the layer is a group.
bool


Layer visibility. Takes group visibility in account.
bool


Kind of this layer, such as group, pixel, shape, type, smartobject, or psdimage. Class name without layer suffix.
str


Layer ID.
int layer id. if the layer is not assigned an id, -1.


Left coordinate. Writable.
int


Returns mask associated with this layer.
Mask or None


Layer name. Writable.
str


Get NumPy array of the layer.
channel -- Which channel to return, can be 'color', 'shape', 'alpha', or 'mask'. Default is 'color+alpha'.
numpy.ndarray or None if there is no pixel.


(left, top) tuple. Writable.
tuple


Opacity of this layer in [0, 255] range. Writable.
int


Property for a list of live shapes or a line.

Some of the vector masks have associated live shape properties, that are Photoshop feature to handle primitive shapes such as a rectangle, an ellipse, or a line. Vector masks without live shape properties are plain path objects.

See psd_tools.api.shape.

List of Invalidated, Rectangle, RoundedRectangle, Ellipse, or Line.


Parent of this layer.

Right coordinate.
int


(width, height) tuple.
tuple


Property for strokes.

Layer tagged blocks that is a dict-like container of settings.

See psd_tools.constants.Tag for available keys.

TaggedBlocks or None.

Example:

from psd_tools.constants import Tag
metadata = layer.tagged_blocks.get_data(Tag.METADATA_SETTING)



Top coordinate. Writable.
int


Get PIL Image of the layer.
  • channel -- Which channel to return; e.g., 0 for 'R' channel in RGB image. See ChannelID. When None, the method returns all the channels supported by PIL modes.
  • apply_icc -- Whether to apply ICC profile conversion to sRGB.

PIL.Image, or None if the layer has no pixels.

Example:

from psd_tools.constants import ChannelID
image = layer.topil()
red = layer.topil(ChannelID.CHANNEL_0)
alpha = layer.topil(ChannelID.TRANSPARENCY_MASK)


NOTE:

Not all of the PSD image modes are supported in PIL.Image. For example, 'CMYK' mode cannot include alpha channel in PIL. In this case, topil drops alpha channel.



Returns vector mask associated with this layer.
VectorMask or None


Layer visibility. Doesn't take group visibility in account. Writable.
bool


Width of the layer.
int



GradientFill

Gradient fill.
(left, top, right, bottom) tuple.

Blend mode of this layer. Writable.

Example:

from psd_tools.constants import BlendMode
if layer.blend_mode == BlendMode.NORMAL:


    layer.blend_mode = BlendMode.SCREEN


BlendMode.


Bottom coordinate.
int


Clip layers associated with this layer.

To compose clipping layers:

from psd_tools import compose
clip_mask = compose(layer.clip_layers)


list of layers


Clipping flag for this layer. Writable.
bool


Deprecated, use composite().

Compose layer and masks (mask, vector mask, and clipping layers).

Note that the resulting image size is not necessarily equal to the layer size due to different mask dimensions. The offset of the composed image is stored at .info['offset'] attribute of PIL.Image.

bbox -- Viewport bounding box specified by (x1, y1, x2, y2) tuple.
PIL.Image, or None if the layer has no pixel.


Composite layer and masks (mask, vector mask, and clipping layers).
  • viewport -- Viewport bounding box specified by (x1, y1, x2, y2) tuple. Default is the layer's bbox.
  • force -- Boolean flag to force vector drawing.
  • color -- Backdrop color specified by scalar or tuple of scalar. The color value should be in [0.0, 1.0]. For example, (1., 0., 0.) specifies red in RGB color mode.
  • alpha -- Backdrop alpha in [0.0, 1.0].
  • layer_filter -- Callable that takes a layer as argument and returns whether if the layer is composited. Default is is_visible().

PIL.Image.


Gradient in Descriptor(GRADIENT).

Layer effects.
Effects


Kind of the gradient, one of the following:
  • Linear
  • Radial
  • Angle
  • Reflected
  • Diamond




Returns True if the layer has associated clipping.
bool


Returns True if the layer has effects.
bool


Returns True if the layer has a mask.
bool


Returns True if the layer has live shape properties.
bool


Returns True if the layer has associated pixels. When this is True, topil method returns PIL.Image.
bool


Returns True if the shape has a stroke.

Returns True if the layer has a vector mask.
bool


Height of the layer.
int


Return True if the layer is a group.
bool


Layer visibility. Takes group visibility in account.
bool


Kind of this layer, such as group, pixel, shape, type, smartobject, or psdimage. Class name without layer suffix.
str


Layer ID.
int layer id. if the layer is not assigned an id, -1.


Left coordinate. Writable.
int


Returns mask associated with this layer.
Mask or None


Layer name. Writable.
str


Get NumPy array of the layer.
channel -- Which channel to return, can be 'color', 'shape', 'alpha', or 'mask'. Default is 'color+alpha'.
numpy.ndarray or None if there is no pixel.


(left, top) tuple. Writable.
tuple


Opacity of this layer in [0, 255] range. Writable.
int


Property for a list of live shapes or a line.

Some of the vector masks have associated live shape properties, that are Photoshop feature to handle primitive shapes such as a rectangle, an ellipse, or a line. Vector masks without live shape properties are plain path objects.

See psd_tools.api.shape.

List of Invalidated, Rectangle, RoundedRectangle, Ellipse, or Line.


Parent of this layer.

Right coordinate.
int


(width, height) tuple.
tuple


Property for strokes.

Layer tagged blocks that is a dict-like container of settings.

See psd_tools.constants.Tag for available keys.

TaggedBlocks or None.

Example:

from psd_tools.constants import Tag
metadata = layer.tagged_blocks.get_data(Tag.METADATA_SETTING)



Top coordinate. Writable.
int


Get PIL Image of the layer.
  • channel -- Which channel to return; e.g., 0 for 'R' channel in RGB image. See ChannelID. When None, the method returns all the channels supported by PIL modes.
  • apply_icc -- Whether to apply ICC profile conversion to sRGB.

PIL.Image, or None if the layer has no pixels.

Example:

from psd_tools.constants import ChannelID
image = layer.topil()
red = layer.topil(ChannelID.CHANNEL_0)
alpha = layer.topil(ChannelID.TRANSPARENCY_MASK)


NOTE:

Not all of the PSD image modes are supported in PIL.Image. For example, 'CMYK' mode cannot include alpha channel in PIL. In this case, topil drops alpha channel.



Returns vector mask associated with this layer.
VectorMask or None


Layer visibility. Doesn't take group visibility in account. Writable.
bool


Width of the layer.
int



Adjustment layers

Adjustment layers apply image filtering to the composed result. All adjustment layers inherit from AdjustmentLayer. Adjustment layers do not have pixels, and currently ignored in compose. Attempts to call topil on adjustment layers always return None.

Just as any other layer, adjustment layers might have an associated mask or vector mask. Adjustment can appear in other layers' clipping layers.

Example:

if isinstance(layer, psd_tools.layers.AdjustmentLayer):


    print(layer.kind)


BrightnessContrast

Brightness and contrast adjustment.








Curves

Curves adjustment.
Raw data.
Curves




Exposure

Exposure adjustment.
Exposure.
float


Gamma.
float


Offset.
float



Levels

Levels adjustment.

Levels contain a list of LevelRecord.

List of level records. The first record is the master.
Levels.


Master record.


Vibrance

Vibrance adjustment.
Saturation.
int


Vibrance.
int



HueSaturation

Hue/Saturation adjustment.

HueSaturation contains a list of data.

Colorization.
tuple


List of Hue/Saturation records.
list


Enable colorization.
int


Master record.
tuple



ColorBalance

Color balance adjustment.
Highlights.
tuple


Luminosity.
int


Mid-tones.
tuple


Shadows.
tuple



BlackAndWhite

Black and white adjustment.











PhotoFilter

Photo filter adjustment.




xyz.
bool



ChannelMixer

Channel mixer adjustment.



ColorLookup

Color lookup adjustment.

Posterize

Posterize adjustment.
Posterize value.
int



Threshold

Threshold adjustment.
Threshold value.
int



SelectiveColor

Selective color adjustment.



GradientMap

Gradient map adjustment.





Interpolation between 0.0 and 1.0.












psd_tools.api.effects

Effects module.

List-like effects.
Whether if all the effects are enabled.
bool


Iterate effect items by name.

Scale value.


DropShadow

Angle value.

Angi-aliased.

Effect blending mode.

Choke level.

Color.

Contour configuration.

Distance.

Whether if the effect is enabled.

Layers are knocking out.

Noise level.

Layer effect opacity in percentage.

Whether if the effect is present in Photoshop UI.

Whether if the effect is shown in dialog.

Size in pixels.

Using global light.


InnerShadow

Angle value.

Angi-aliased.

Effect blending mode.

Choke level.

Color.

Contour configuration.

Distance.

Whether if the effect is enabled.

Noise level.

Layer effect opacity in percentage.

Whether if the effect is present in Photoshop UI.

Whether if the effect is shown in dialog.

Size in pixels.

Using global light.


OuterGlow

Angle value.

Angi-aliased.

Effect blending mode.

Choke level.

Color.

Contour configuration.

Dither flag.

Whether if the effect is enabled.

Glow type.

Gradient configuration.

Noise level.

Offset value.

Layer effect opacity in percentage.

Whether if the effect is present in Photoshop UI.

Quality jitter

Quality range.

Reverse flag.

Whether if the effect is shown in dialog.

Size in pixels.

Gradient type, one of linear, radial, angle, reflected, or diamond.


InnerGlow

Angle value.

Angi-aliased.

Effect blending mode.

Choke level.

Color.

Contour configuration.

Dither flag.

Whether if the effect is enabled.

Elements source.

Glow type.

Gradient configuration.

Noise level.

Offset value.

Layer effect opacity in percentage.

Whether if the effect is present in Photoshop UI.

Quality jitter

Quality range.

Reverse flag.

Whether if the effect is shown in dialog.

Size in pixels.

Gradient type, one of linear, radial, angle, reflected, or diamond.


ColorOverlay

Effect blending mode.

Color.

Whether if the effect is enabled.

Layer effect opacity in percentage.

Whether if the effect is present in Photoshop UI.

Whether if the effect is shown in dialog.


GradientOverlay

Aligned.

Angle value.

Effect blending mode.

Dither flag.

Whether if the effect is enabled.

Gradient configuration.

Offset value.

Layer effect opacity in percentage.

Whether if the effect is present in Photoshop UI.

Reverse flag.

Scale value.

Whether if the effect is shown in dialog.

Gradient type, one of linear, radial, angle, reflected, or diamond.


PatternOverlay

Aligned.

Angle value.

Effect blending mode.

Whether if the effect is enabled.

Linked.

Layer effect opacity in percentage.

Pattern config.

Phase value in Point.

Whether if the effect is present in Photoshop UI.

Scale value.

Whether if the effect is shown in dialog.


Stroke

Angle value.

Effect blending mode.

Color.

Dither flag.

Whether if the effect is enabled.

Fill type, SolidColor, Gradient, or Pattern.

Gradient configuration.

Linked.

Offset value.

Layer effect opacity in percentage.

Overprint flag.

Pattern config.

Phase value in Point.

Position of the stroke, InsetFrame, OutsetFrame, or CenteredFrame.

Whether if the effect is present in Photoshop UI.

Reverse flag.

Whether if the effect is shown in dialog.

Size value.

Gradient type, one of linear, radial, angle, reflected, or diamond.


BevelEmboss

Altitude value.

Angle value.

Anti-aliased.

Bevel style, one of OuterBevel, InnerBevel, Emboss, PillowEmboss, or StrokeEmboss.

Bevel type, one of SoftMatte, HardLight, SoftLight.

Contour configuration.

Depth value.

Direction, either StampIn or StampOut.

Whether if the effect is enabled.

Highlight color value.

Highlight blending mode.

Highlight opacity value.

Layer effect opacity in percentage.

Whether if the effect is present in Photoshop UI.

Shadow color value.

Shadow blending mode.

Shadow opacity value.

Whether if the effect is shown in dialog.

Size value in pixel.

Soften value.

Using global light.

Using shape.

Using texture.


Satin

Satin effect
Angle value.

Anti-aliased.

Effect blending mode.

Color.

Contour configuration.

Distance value.

Whether if the effect is enabled.

Inverted.

Layer effect opacity in percentage.

Whether if the effect is present in Photoshop UI.

Whether if the effect is shown in dialog.

Size value in pixel.


psd_tools.api.layers

Layer module.

Artboard

Artboard is a special kind of group that has a pre-defined viewbox.

Example:

artboard = psd[1]
image = artboard.compose()


(left, top, right, bottom) tuple.

Blend mode of this layer. Writable.

Example:

from psd_tools.constants import BlendMode
if layer.blend_mode == BlendMode.NORMAL:


    layer.blend_mode = BlendMode.SCREEN


BlendMode.


Bottom coordinate.
int


Clip layers associated with this layer.

To compose clipping layers:

from psd_tools import compose
clip_mask = compose(layer.clip_layers)


list of layers


Clipping flag for this layer. Writable.
bool


Compose the artboard.

See compose() for available extra arguments.

bbox -- Viewport tuple (left, top, right, bottom).
PIL.Image, or None if there is no pixel.


Composite layer and masks (mask, vector mask, and clipping layers).
  • viewport -- Viewport bounding box specified by (x1, y1, x2, y2) tuple. Default is the layer's bbox.
  • force -- Boolean flag to force vector drawing.
  • color -- Backdrop color specified by scalar or tuple of scalar. The color value should be in [0.0, 1.0]. For example, (1., 0., 0.) specifies red in RGB color mode.
  • alpha -- Backdrop alpha in [0.0, 1.0].
  • layer_filter -- Callable that takes a layer as argument and returns whether if the layer is composited. Default is is_visible().

PIL.Image.


Return a generator to iterate over all descendant layers.

Example:

# Iterate over all layers
for layer in psd.descendants():


    print(layer)
# Iterate over all layers in reverse order
for layer in reversed(list(psd.descendants())):


    print(layer)


include_clip -- include clipping layers.


Layer effects.
Effects


Returns a bounding box for layers or (0, 0, 0, 0) if the layers have no bounding box.
include_invisible -- include invisible layers in calculation.
tuple of four int


Returns True if the layer has associated clipping.
bool


Returns True if the layer has effects.
bool


Returns True if the layer has a mask.
bool


Returns True if the layer has live shape properties.
bool


Returns True if the layer has associated pixels. When this is True, topil method returns PIL.Image.
bool


Returns True if the shape has a stroke.

Returns True if the layer has a vector mask.
bool


Height of the layer.
int


Return True if the layer is a group.
bool


Layer visibility. Takes group visibility in account.
bool


Kind of this layer, such as group, pixel, shape, type, smartobject, or psdimage. Class name without layer suffix.
str


Layer ID.
int layer id. if the layer is not assigned an id, -1.


Left coordinate. Writable.
int


Returns mask associated with this layer.
Mask or None


Layer name. Writable.
str


Get NumPy array of the layer.
channel -- Which channel to return, can be 'color', 'shape', 'alpha', or 'mask'. Default is 'color+alpha'.
numpy.ndarray or None if there is no pixel.


(left, top) tuple. Writable.
tuple


Opacity of this layer in [0, 255] range. Writable.
int


Property for a list of live shapes or a line.

Some of the vector masks have associated live shape properties, that are Photoshop feature to handle primitive shapes such as a rectangle, an ellipse, or a line. Vector masks without live shape properties are plain path objects.

See psd_tools.api.shape.

List of Invalidated, Rectangle, RoundedRectangle, Ellipse, or Line.


Parent of this layer.

Right coordinate.
int


(width, height) tuple.
tuple


Property for strokes.

Layer tagged blocks that is a dict-like container of settings.

See psd_tools.constants.Tag for available keys.

TaggedBlocks or None.

Example:

from psd_tools.constants import Tag
metadata = layer.tagged_blocks.get_data(Tag.METADATA_SETTING)



Top coordinate. Writable.
int


Get PIL Image of the layer.
  • channel -- Which channel to return; e.g., 0 for 'R' channel in RGB image. See ChannelID. When None, the method returns all the channels supported by PIL modes.
  • apply_icc -- Whether to apply ICC profile conversion to sRGB.

PIL.Image, or None if the layer has no pixels.

Example:

from psd_tools.constants import ChannelID
image = layer.topil()
red = layer.topil(ChannelID.CHANNEL_0)
alpha = layer.topil(ChannelID.TRANSPARENCY_MASK)


NOTE:

Not all of the PSD image modes are supported in PIL.Image. For example, 'CMYK' mode cannot include alpha channel in PIL. In this case, topil drops alpha channel.



Returns vector mask associated with this layer.
VectorMask or None


Layer visibility. Doesn't take group visibility in account. Writable.
bool


Width of the layer.
int



Group

Group of layers.

Example:

group = psd[1]
for layer in group:


    if layer.kind == 'pixel':


        print(layer.name)


(left, top, right, bottom) tuple.

Blend mode of this layer. Writable.

Example:

from psd_tools.constants import BlendMode
if layer.blend_mode == BlendMode.NORMAL:


    layer.blend_mode = BlendMode.SCREEN


BlendMode.


Bottom coordinate.
int


Clip layers associated with this layer.

To compose clipping layers:

from psd_tools import compose
clip_mask = compose(layer.clip_layers)


list of layers


Clipping flag for this layer. Writable.
bool


Compose layer and masks (mask, vector mask, and clipping layers).
PIL Image object, or None if the layer has no pixels.


Composite layer and masks (mask, vector mask, and clipping layers).
  • viewport -- Viewport bounding box specified by (x1, y1, x2, y2) tuple. Default is the layer's bbox.
  • force -- Boolean flag to force vector drawing.
  • color -- Backdrop color specified by scalar or tuple of scalar. The color value should be in [0.0, 1.0]. For example, (1., 0., 0.) specifies red in RGB color mode.
  • alpha -- Backdrop alpha in [0.0, 1.0].
  • layer_filter -- Callable that takes a layer as argument and returns whether if the layer is composited. Default is is_visible().

PIL.Image.


Return a generator to iterate over all descendant layers.

Example:

# Iterate over all layers
for layer in psd.descendants():


    print(layer)
# Iterate over all layers in reverse order
for layer in reversed(list(psd.descendants())):


    print(layer)


include_clip -- include clipping layers.


Layer effects.
Effects


Returns a bounding box for layers or (0, 0, 0, 0) if the layers have no bounding box.
include_invisible -- include invisible layers in calculation.
tuple of four int


Returns True if the layer has associated clipping.
bool


Returns True if the layer has effects.
bool


Returns True if the layer has a mask.
bool


Returns True if the layer has live shape properties.
bool


Returns True if the layer has associated pixels. When this is True, topil method returns PIL.Image.
bool


Returns True if the shape has a stroke.

Returns True if the layer has a vector mask.
bool


Height of the layer.
int


Return True if the layer is a group.
bool


Layer visibility. Takes group visibility in account.
bool


Kind of this layer, such as group, pixel, shape, type, smartobject, or psdimage. Class name without layer suffix.
str


Layer ID.
int layer id. if the layer is not assigned an id, -1.


Left coordinate. Writable.
int


Returns mask associated with this layer.
Mask or None


Layer name. Writable.
str


Get NumPy array of the layer.
channel -- Which channel to return, can be 'color', 'shape', 'alpha', or 'mask'. Default is 'color+alpha'.
numpy.ndarray or None if there is no pixel.


(left, top) tuple. Writable.
tuple


Opacity of this layer in [0, 255] range. Writable.
int


Property for a list of live shapes or a line.

Some of the vector masks have associated live shape properties, that are Photoshop feature to handle primitive shapes such as a rectangle, an ellipse, or a line. Vector masks without live shape properties are plain path objects.

See psd_tools.api.shape.

List of Invalidated, Rectangle, RoundedRectangle, Ellipse, or Line.


Parent of this layer.

Right coordinate.
int


(width, height) tuple.
tuple


Property for strokes.

Layer tagged blocks that is a dict-like container of settings.

See psd_tools.constants.Tag for available keys.

TaggedBlocks or None.

Example:

from psd_tools.constants import Tag
metadata = layer.tagged_blocks.get_data(Tag.METADATA_SETTING)



Top coordinate. Writable.
int


Get PIL Image of the layer.
  • channel -- Which channel to return; e.g., 0 for 'R' channel in RGB image. See ChannelID. When None, the method returns all the channels supported by PIL modes.
  • apply_icc -- Whether to apply ICC profile conversion to sRGB.

PIL.Image, or None if the layer has no pixels.

Example:

from psd_tools.constants import ChannelID
image = layer.topil()
red = layer.topil(ChannelID.CHANNEL_0)
alpha = layer.topil(ChannelID.TRANSPARENCY_MASK)


NOTE:

Not all of the PSD image modes are supported in PIL.Image. For example, 'CMYK' mode cannot include alpha channel in PIL. In this case, topil drops alpha channel.



Returns vector mask associated with this layer.
VectorMask or None


Layer visibility. Doesn't take group visibility in account. Writable.
bool


Width of the layer.
int



PixelLayer

Layer that has rasterized image in pixels.

Example:

assert layer.kind == 'pixel':
image = layer.topil()
image.save('layer.png')
composed_image = layer.compose()
composed_image.save('composed-layer.png')


(left, top, right, bottom) tuple.

Blend mode of this layer. Writable.

Example:

from psd_tools.constants import BlendMode
if layer.blend_mode == BlendMode.NORMAL:


    layer.blend_mode = BlendMode.SCREEN


BlendMode.


Bottom coordinate.
int


Clip layers associated with this layer.

To compose clipping layers:

from psd_tools import compose
clip_mask = compose(layer.clip_layers)


list of layers


Clipping flag for this layer. Writable.
bool


Deprecated, use composite().

Compose layer and masks (mask, vector mask, and clipping layers).

Note that the resulting image size is not necessarily equal to the layer size due to different mask dimensions. The offset of the composed image is stored at .info['offset'] attribute of PIL.Image.

bbox -- Viewport bounding box specified by (x1, y1, x2, y2) tuple.
PIL.Image, or None if the layer has no pixel.


Composite layer and masks (mask, vector mask, and clipping layers).
  • viewport -- Viewport bounding box specified by (x1, y1, x2, y2) tuple. Default is the layer's bbox.
  • force -- Boolean flag to force vector drawing.
  • color -- Backdrop color specified by scalar or tuple of scalar. The color value should be in [0.0, 1.0]. For example, (1., 0., 0.) specifies red in RGB color mode.
  • alpha -- Backdrop alpha in [0.0, 1.0].
  • layer_filter -- Callable that takes a layer as argument and returns whether if the layer is composited. Default is is_visible().

PIL.Image.


Layer effects.
Effects


Returns True if the layer has associated clipping.
bool


Returns True if the layer has effects.
bool


Returns True if the layer has a mask.
bool


Returns True if the layer has live shape properties.
bool


Returns True if the layer has associated pixels. When this is True, topil method returns PIL.Image.
bool


Returns True if the shape has a stroke.

Returns True if the layer has a vector mask.
bool


Height of the layer.
int


Return True if the layer is a group.
bool


Layer visibility. Takes group visibility in account.
bool


Kind of this layer, such as group, pixel, shape, type, smartobject, or psdimage. Class name without layer suffix.
str


Layer ID.
int layer id. if the layer is not assigned an id, -1.


Left coordinate. Writable.
int


Returns mask associated with this layer.
Mask or None


Layer name. Writable.
str


Get NumPy array of the layer.
channel -- Which channel to return, can be 'color', 'shape', 'alpha', or 'mask'. Default is 'color+alpha'.
numpy.ndarray or None if there is no pixel.


(left, top) tuple. Writable.
tuple


Opacity of this layer in [0, 255] range. Writable.
int


Property for a list of live shapes or a line.

Some of the vector masks have associated live shape properties, that are Photoshop feature to handle primitive shapes such as a rectangle, an ellipse, or a line. Vector masks without live shape properties are plain path objects.

See psd_tools.api.shape.

List of Invalidated, Rectangle, RoundedRectangle, Ellipse, or Line.


Parent of this layer.

Right coordinate.
int


(width, height) tuple.
tuple


Property for strokes.

Layer tagged blocks that is a dict-like container of settings.

See psd_tools.constants.Tag for available keys.

TaggedBlocks or None.

Example:

from psd_tools.constants import Tag
metadata = layer.tagged_blocks.get_data(Tag.METADATA_SETTING)



Top coordinate. Writable.
int


Get PIL Image of the layer.
  • channel -- Which channel to return; e.g., 0 for 'R' channel in RGB image. See ChannelID. When None, the method returns all the channels supported by PIL modes.
  • apply_icc -- Whether to apply ICC profile conversion to sRGB.

PIL.Image, or None if the layer has no pixels.

Example:

from psd_tools.constants import ChannelID
image = layer.topil()
red = layer.topil(ChannelID.CHANNEL_0)
alpha = layer.topil(ChannelID.TRANSPARENCY_MASK)


NOTE:

Not all of the PSD image modes are supported in PIL.Image. For example, 'CMYK' mode cannot include alpha channel in PIL. In this case, topil drops alpha channel.



Returns vector mask associated with this layer.
VectorMask or None


Layer visibility. Doesn't take group visibility in account. Writable.
bool


Width of the layer.
int



ShapeLayer

Layer that has drawing in vector mask.
(left, top, right, bottom) tuple.

Blend mode of this layer. Writable.

Example:

from psd_tools.constants import BlendMode
if layer.blend_mode == BlendMode.NORMAL:


    layer.blend_mode = BlendMode.SCREEN


BlendMode.


Bottom coordinate.
int


Clip layers associated with this layer.

To compose clipping layers:

from psd_tools import compose
clip_mask = compose(layer.clip_layers)


list of layers


Clipping flag for this layer. Writable.
bool


Deprecated, use composite().

Compose layer and masks (mask, vector mask, and clipping layers).

Note that the resulting image size is not necessarily equal to the layer size due to different mask dimensions. The offset of the composed image is stored at .info['offset'] attribute of PIL.Image.

bbox -- Viewport bounding box specified by (x1, y1, x2, y2) tuple.
PIL.Image, or None if the layer has no pixel.


Composite layer and masks (mask, vector mask, and clipping layers).
  • viewport -- Viewport bounding box specified by (x1, y1, x2, y2) tuple. Default is the layer's bbox.
  • force -- Boolean flag to force vector drawing.
  • color -- Backdrop color specified by scalar or tuple of scalar. The color value should be in [0.0, 1.0]. For example, (1., 0., 0.) specifies red in RGB color mode.
  • alpha -- Backdrop alpha in [0.0, 1.0].
  • layer_filter -- Callable that takes a layer as argument and returns whether if the layer is composited. Default is is_visible().

PIL.Image.


Layer effects.
Effects


Returns True if the layer has associated clipping.
bool


Returns True if the layer has effects.
bool


Returns True if the layer has a mask.
bool


Returns True if the layer has live shape properties.
bool


Returns True if the layer has associated pixels. When this is True, topil method returns PIL.Image.
bool


Returns True if the shape has a stroke.

Returns True if the layer has a vector mask.
bool


Height of the layer.
int


Return True if the layer is a group.
bool


Layer visibility. Takes group visibility in account.
bool


Kind of this layer, such as group, pixel, shape, type, smartobject, or psdimage. Class name without layer suffix.
str


Layer ID.
int layer id. if the layer is not assigned an id, -1.


Left coordinate. Writable.
int


Returns mask associated with this layer.
Mask or None


Layer name. Writable.
str


Get NumPy array of the layer.
channel -- Which channel to return, can be 'color', 'shape', 'alpha', or 'mask'. Default is 'color+alpha'.
numpy.ndarray or None if there is no pixel.


(left, top) tuple. Writable.
tuple


Opacity of this layer in [0, 255] range. Writable.
int


Property for a list of live shapes or a line.

Some of the vector masks have associated live shape properties, that are Photoshop feature to handle primitive shapes such as a rectangle, an ellipse, or a line. Vector masks without live shape properties are plain path objects.

See psd_tools.api.shape.

List of Invalidated, Rectangle, RoundedRectangle, Ellipse, or Line.


Parent of this layer.

Right coordinate.
int


(width, height) tuple.
tuple


Property for strokes.

Layer tagged blocks that is a dict-like container of settings.

See psd_tools.constants.Tag for available keys.

TaggedBlocks or None.

Example:

from psd_tools.constants import Tag
metadata = layer.tagged_blocks.get_data(Tag.METADATA_SETTING)



Top coordinate. Writable.
int


Get PIL Image of the layer.
  • channel -- Which channel to return; e.g., 0 for 'R' channel in RGB image. See ChannelID. When None, the method returns all the channels supported by PIL modes.
  • apply_icc -- Whether to apply ICC profile conversion to sRGB.

PIL.Image, or None if the layer has no pixels.

Example:

from psd_tools.constants import ChannelID
image = layer.topil()
red = layer.topil(ChannelID.CHANNEL_0)
alpha = layer.topil(ChannelID.TRANSPARENCY_MASK)


NOTE:

Not all of the PSD image modes are supported in PIL.Image. For example, 'CMYK' mode cannot include alpha channel in PIL. In this case, topil drops alpha channel.



Returns vector mask associated with this layer.
VectorMask or None


Layer visibility. Doesn't take group visibility in account. Writable.
bool


Width of the layer.
int



SmartObjectLayer

Layer that inserts external data.

Use smart_object attribute to get the external data. See SmartObject.

Example:

import io
if layer.smart_object.filetype == 'jpg':


    image = Image.open(io.BytesIO(layer.smart_object.data))


(left, top, right, bottom) tuple.

Blend mode of this layer. Writable.

Example:

from psd_tools.constants import BlendMode
if layer.blend_mode == BlendMode.NORMAL:


    layer.blend_mode = BlendMode.SCREEN


BlendMode.


Bottom coordinate.
int


Clip layers associated with this layer.

To compose clipping layers:

from psd_tools import compose
clip_mask = compose(layer.clip_layers)


list of layers


Clipping flag for this layer. Writable.
bool


Deprecated, use composite().

Compose layer and masks (mask, vector mask, and clipping layers).

Note that the resulting image size is not necessarily equal to the layer size due to different mask dimensions. The offset of the composed image is stored at .info['offset'] attribute of PIL.Image.

bbox -- Viewport bounding box specified by (x1, y1, x2, y2) tuple.
PIL.Image, or None if the layer has no pixel.


Composite layer and masks (mask, vector mask, and clipping layers).
  • viewport -- Viewport bounding box specified by (x1, y1, x2, y2) tuple. Default is the layer's bbox.
  • force -- Boolean flag to force vector drawing.
  • color -- Backdrop color specified by scalar or tuple of scalar. The color value should be in [0.0, 1.0]. For example, (1., 0., 0.) specifies red in RGB color mode.
  • alpha -- Backdrop alpha in [0.0, 1.0].
  • layer_filter -- Callable that takes a layer as argument and returns whether if the layer is composited. Default is is_visible().

PIL.Image.


Layer effects.
Effects


Returns True if the layer has associated clipping.
bool


Returns True if the layer has effects.
bool


Returns True if the layer has a mask.
bool


Returns True if the layer has live shape properties.
bool


Returns True if the layer has associated pixels. When this is True, topil method returns PIL.Image.
bool


Returns True if the shape has a stroke.

Returns True if the layer has a vector mask.
bool


Height of the layer.
int


Return True if the layer is a group.
bool


Layer visibility. Takes group visibility in account.
bool


Kind of this layer, such as group, pixel, shape, type, smartobject, or psdimage. Class name without layer suffix.
str


Layer ID.
int layer id. if the layer is not assigned an id, -1.


Left coordinate. Writable.
int


Returns mask associated with this layer.
Mask or None


Layer name. Writable.
str


Get NumPy array of the layer.
channel -- Which channel to return, can be 'color', 'shape', 'alpha', or 'mask'. Default is 'color+alpha'.
numpy.ndarray or None if there is no pixel.


(left, top) tuple. Writable.
tuple


Opacity of this layer in [0, 255] range. Writable.
int


Property for a list of live shapes or a line.

Some of the vector masks have associated live shape properties, that are Photoshop feature to handle primitive shapes such as a rectangle, an ellipse, or a line. Vector masks without live shape properties are plain path objects.

See psd_tools.api.shape.

List of Invalidated, Rectangle, RoundedRectangle, Ellipse, or Line.


Parent of this layer.

Right coordinate.
int


(width, height) tuple.
tuple


Associated smart object.
SmartObject.


Property for strokes.

Layer tagged blocks that is a dict-like container of settings.

See psd_tools.constants.Tag for available keys.

TaggedBlocks or None.

Example:

from psd_tools.constants import Tag
metadata = layer.tagged_blocks.get_data(Tag.METADATA_SETTING)



Top coordinate. Writable.
int


Get PIL Image of the layer.
  • channel -- Which channel to return; e.g., 0 for 'R' channel in RGB image. See ChannelID. When None, the method returns all the channels supported by PIL modes.
  • apply_icc -- Whether to apply ICC profile conversion to sRGB.

PIL.Image, or None if the layer has no pixels.

Example:

from psd_tools.constants import ChannelID
image = layer.topil()
red = layer.topil(ChannelID.CHANNEL_0)
alpha = layer.topil(ChannelID.TRANSPARENCY_MASK)


NOTE:

Not all of the PSD image modes are supported in PIL.Image. For example, 'CMYK' mode cannot include alpha channel in PIL. In this case, topil drops alpha channel.



Returns vector mask associated with this layer.
VectorMask or None


Layer visibility. Doesn't take group visibility in account. Writable.
bool


Width of the layer.
int



TypeLayer

Layer that has text and styling information for fonts or paragraphs.

Text is accessible at text property. Styling information for paragraphs is in engine_dict. Document styling information such as font list is is resource_dict.

Currently, textual information is read-only.

Example:

if layer.kind == 'type':


    print(layer.text)


    print(layer.engine_dict['StyleRun'])


    # Extract font for each substring in the text.


    text = layer.engine_dict['Editor']['Text'].value


    fontset = layer.resource_dict['FontSet']


    runlength = layer.engine_dict['StyleRun']['RunLengthArray']


    rundata = layer.engine_dict['StyleRun']['RunArray']


    index = 0


    for length, style in zip(runlength, rundata):


        substring = text[index:index + length]


        stylesheet = style['StyleSheet']['StyleSheetData']


        font = fontset[stylesheet['Font']]


        print('%r gets %s' % (substring, font))


        index += length


(left, top, right, bottom) tuple.

Blend mode of this layer. Writable.

Example:

from psd_tools.constants import BlendMode
if layer.blend_mode == BlendMode.NORMAL:


    layer.blend_mode = BlendMode.SCREEN


BlendMode.


Bottom coordinate.
int


Clip layers associated with this layer.

To compose clipping layers:

from psd_tools import compose
clip_mask = compose(layer.clip_layers)


list of layers


Clipping flag for this layer. Writable.
bool


Deprecated, use composite().

Compose layer and masks (mask, vector mask, and clipping layers).

Note that the resulting image size is not necessarily equal to the layer size due to different mask dimensions. The offset of the composed image is stored at .info['offset'] attribute of PIL.Image.

bbox -- Viewport bounding box specified by (x1, y1, x2, y2) tuple.
PIL.Image, or None if the layer has no pixel.


Composite layer and masks (mask, vector mask, and clipping layers).
  • viewport -- Viewport bounding box specified by (x1, y1, x2, y2) tuple. Default is the layer's bbox.
  • force -- Boolean flag to force vector drawing.
  • color -- Backdrop color specified by scalar or tuple of scalar. The color value should be in [0.0, 1.0]. For example, (1., 0., 0.) specifies red in RGB color mode.
  • alpha -- Backdrop alpha in [0.0, 1.0].
  • layer_filter -- Callable that takes a layer as argument and returns whether if the layer is composited. Default is is_visible().

PIL.Image.


Resource set relevant to the document.

Layer effects.
Effects


Styling information dict.

Returns True if the layer has associated clipping.
bool


Returns True if the layer has effects.
bool


Returns True if the layer has a mask.
bool


Returns True if the layer has live shape properties.
bool


Returns True if the layer has associated pixels. When this is True, topil method returns PIL.Image.
bool


Returns True if the shape has a stroke.

Returns True if the layer has a vector mask.
bool


Height of the layer.
int


Return True if the layer is a group.
bool


Layer visibility. Takes group visibility in account.
bool


Kind of this layer, such as group, pixel, shape, type, smartobject, or psdimage. Class name without layer suffix.
str


Layer ID.
int layer id. if the layer is not assigned an id, -1.


Left coordinate. Writable.
int


Returns mask associated with this layer.
Mask or None


Layer name. Writable.
str


Get NumPy array of the layer.
channel -- Which channel to return, can be 'color', 'shape', 'alpha', or 'mask'. Default is 'color+alpha'.
numpy.ndarray or None if there is no pixel.


(left, top) tuple. Writable.
tuple


Opacity of this layer in [0, 255] range. Writable.
int


Property for a list of live shapes or a line.

Some of the vector masks have associated live shape properties, that are Photoshop feature to handle primitive shapes such as a rectangle, an ellipse, or a line. Vector masks without live shape properties are plain path objects.

See psd_tools.api.shape.

List of Invalidated, Rectangle, RoundedRectangle, Ellipse, or Line.


Parent of this layer.

Resource set.

Right coordinate.
int


(width, height) tuple.
tuple


Property for strokes.

Layer tagged blocks that is a dict-like container of settings.

See psd_tools.constants.Tag for available keys.

TaggedBlocks or None.

Example:

from psd_tools.constants import Tag
metadata = layer.tagged_blocks.get_data(Tag.METADATA_SETTING)



Text in the layer. Read-only.

NOTE:

New-line character in Photoshop is '\r'.



Text type. Read-only.
  • psd_tools.constants.TextType.POINT for point type text (also known as character type)
  • psd_tools.constants.TextType.PARAGRAPH for paragraph type text (also known as area type)
  • None if text type cannot be determined or information is unavailable


See psd_tools.constants.TextType.


Top coordinate. Writable.
int


Get PIL Image of the layer.
  • channel -- Which channel to return; e.g., 0 for 'R' channel in RGB image. See ChannelID. When None, the method returns all the channels supported by PIL modes.
  • apply_icc -- Whether to apply ICC profile conversion to sRGB.

PIL.Image, or None if the layer has no pixels.

Example:

from psd_tools.constants import ChannelID
image = layer.topil()
red = layer.topil(ChannelID.CHANNEL_0)
alpha = layer.topil(ChannelID.TRANSPARENCY_MASK)


NOTE:

Not all of the PSD image modes are supported in PIL.Image. For example, 'CMYK' mode cannot include alpha channel in PIL. In this case, topil drops alpha channel.



Matrix (xx, xy, yx, yy, tx, ty) applies affine transformation.

Returns vector mask associated with this layer.
VectorMask or None


Layer visibility. Doesn't take group visibility in account. Writable.
bool


Warp configuration.

Width of the layer.
int



psd_tools.api.mask

Mask module.

Mask

Mask data attached to a layer.

There are two distinct internal mask data: user mask and vector mask. User mask refers any pixel-based mask whereas vector mask refers a mask from a shape path. Internally, two masks are combined and referred real mask.

Background color.

BBox

Bottom coordinate.

Disabled.

Flags.

Height.

Left coordinate.

Parameters.

Real flag.

Right coordinate.

(Width, Height) tuple.

Top coordinate.

Get PIL Image of the mask.
real -- When True, returns pixel + vector mask combined.
PIL Image object, or None if the mask is empty.


Width.


psd_tools.api.shape

Shape module.

In PSD/PSB, shapes are all represented as VectorMask in each layer, and optionally there might be Origination object to control live shape properties and Stroke to specify how outline is stylized.

VectorMask

Vector mask data.

Vector mask is a resolution-independent mask that consists of one or more Path objects. In Photoshop, all the path objects are represented as Bezier curves. Check paths property for how to deal with path objects.

Bounding box tuple (left, top, right, bottom) in relative coordinates, where top-left corner is (0., 0.) and bottom-right corner is (1., 1.).
tuple


Clipboard record containing bounding box information.

Depending on the Photoshop version, this field can be None.


If the mask is disabled.

Initial fill rule.

When 0, fill inside of the path. When 1, fill outside of the shape.

int


Invert the mask.

If the knots are not linked.

List of Subpath. Subpath is a list-like structure that contains one or more Knot items. Knot contains relative coordinates of control points for a Bezier curve. index indicates which origination item the subpath belongs, and operation indicates how to combine multiple shape paths.

In PSD, path fill rule is even-odd.

Example:

for subpath in layer.vector_mask.paths:


    anchors = [(


        int(knot.anchor[1] * psd.width),


        int(knot.anchor[0] * psd.height),


    ) for knot in subpath]


List of Subpath.



Stroke

Stroke contains decorative information for strokes.

This is a thin wrapper around Descriptor structure. Check _data attribute to get the raw data.

Blend mode.

Fill effect.

If the stroke is enabled.

If the stroke fill is enabled.

Alignment, one of inner, outer, center.

Cap type, one of butt, round, square.

Line dash offset in float.
float


Line dash set in list of UnitFloat.
list


Join type, one of miter, round, bevel.

Stroke width in float.

Miter limit in float.

Opacity value.

Stroke adjust


Origination

Origination keeps live shape properties for some of the primitive shapes. Origination objects are accessible via origination property of layers. Following primitive shapes are defined: Invalidated, Line, Rectangle, Ellipse, and RoundedRectangle.

Invalidated

Invalidated live shape.

This equals to a primitive shape that does not provide Live shape properties. Use VectorMask to access shape information instead of this origination object.

bool



Line

Line live shape.
int


Line arrow end.
bool


Line arrow length.
float


Line arrow start.
bool


Line arrow width.
float


Bounding box of the live shape.
Descriptor


Origination item index.
int


bool


Line end.
Descriptor


Line start.
Descriptor


Line weight
float


Type of the vector shape.
  • 1: Rectangle
  • 2: RoundedRectangle
  • 4: Line
  • 5: Ellipse

int


Resolution.
float



Ellipse

Ellipse live shape.
Bounding box of the live shape.
Descriptor


Origination item index.
int


bool


Type of the vector shape.
  • 1: Rectangle
  • 2: RoundedRectangle
  • 4: Line
  • 5: Ellipse

int


Resolution.
float



Rectangle

Rectangle live shape.
Bounding box of the live shape.
Descriptor


Origination item index.
int


bool


Type of the vector shape.
  • 1: Rectangle
  • 2: RoundedRectangle
  • 4: Line
  • 5: Ellipse

int


Resolution.
float



RoundedRectangle

Rounded rectangle live shape.
Bounding box of the live shape.
Descriptor


Origination item index.
int


bool


Type of the vector shape.
  • 1: Rectangle
  • 2: RoundedRectangle
  • 4: Line
  • 5: Ellipse

int


Corner radii of rounded rectangles. The order is top-left, top-right, bottom-left, bottom-right.
Descriptor


Resolution.
float



psd_tools.api.smart_object

Smart object module.

SmartObject

Smart object that represents embedded or external file.

Smart objects are attached to SmartObjectLayer.

Embedded file content, or empty if kind is external or alias

Original file name of the object.

File size of the object.

Preferred file extension, such as jpg.

Return True if the file is embedded PSD/PSB.

Kind of the link, 'data', 'alias', or 'external'.

Open the smart object as binary IO.
external_dir -- Path to the directory of the external file.

Example:

with layer.smart_object.open() as f:


    data = f.read()



Resolution of the object.

Save the smart object to a file.
filename -- File name to export. If None, use the embedded name.


A tuple representing the coordinates of the smart objects's transformed box. This box is the result of one or more transformations such as scaling, rotation, translation, or skewing to the original bounding box of the smart object.

The format of the tuple is as follows: (x1, y1, x2, y2, x3, y3, x4, y4)

Where 1 is top left corner, 2 is top right, 3 is bottom right and 4 is bottom left.


UUID of the object.

Warp parameters.


psd_tools.constants

Various constants for psd_tools

BlendMode

Blend modes.





























ChannelID

Channel types.














Clipping

Clipping.



ColorMode

Color mode.










ColorSpaceID

Color space types.






Compression

Compression modes.

Compression. 0 = Raw Data, 1 = RLE compressed, 2 = ZIP without prediction, 3 = ZIP with prediction.






EffectOSType

OS Type keys for Layer Effects.








GlobalLayerMaskKind

Global layer mask kind.




LinkedLayerType

Linked layer types.




PathResourceID











PlacedLayerType






PrintScaleStyle

Print scale style.




Resource

Image resource keys.

Note the following is not defined for performance reasons.

  • PATH_INFO_10 to PATH_INFO_989 corresponding to 2010 - 2989
4010 - 4989








































































































































SectionDivider






Tag

Tagged blocks keys.




























































































TextType

Type of text



psd_tools.psd

Low-level API that translates binary data to Python structure.

All the data structure in this subpackage inherits from one of the object defined in psd_tools.psd.base module.

PSD

Low-level PSD file structure that resembles the specification.

Example:

from psd_tools.psd import PSD
with open(input_file, 'rb') as f:


    psd = PSD.read(f)
with open(output_file, 'wb') as f:


    psd.write(f)


See FileHeader.

See ColorModeData.

See ImageResources.

See LayerAndMaskInformation.

See ImageData.


psd_tools.psd.base

Base data structures intended for inheritance.

All the data objects in this subpackage inherit from the base classes here. That means, all the data structures in the psd_tools.psd subpackage implements the methods of BaseElement for serialization and decoding.

Objects that inherit from the BaseElement typically gets attrs decoration to have data fields.

BaseElement

Base element of various PSD file structs. All the data objects in psd_tools.psd subpackage inherit from this class.
Read the element from a file-like object.

Write the element to a file-like object.

Read the element from bytes.

Write the element to bytes.

Validate the attribute.


EmptyElement

Empty element that does not have a value.

ValueElement

Single value wrapper that has a value attribute.

Pretty printing shows the internal value by default. Inherit with @attr.s(repr=False) decorator to keep this behavior.

Internal value.


NumericElement

Single value element that has a numeric value attribute.

IntegerElement

Single integer value element that has a value attribute.

Use with @attr.s(repr=False) decorator.


ShortIntegerElement

Single short integer element that has a value attribute.

Use with @attr.s(repr=False) decorator.


ByteElement

Single 1-byte integer element that has a value attribute.

Use with @attr.s(repr=False) decorator.


BooleanElement

Single bool value element that has a value attribute.

Use with @attr.s(repr=False) decorator.


StringElement

Single unicode string.
str value


ListElement

List-like element that has items list.

DictElement

Dict-like element that has items OrderedDict.

psd_tools.psd.color_mode_data

Color mode data structure.

ColorModeData

Color mode data section of the PSD file.

For indexed color images the data is the color table for the image in a non-interleaved order.

Duotone images also have this data, but the data format is undocumented.

Returns interleaved color table in bytes.


psd_tools.psd.descriptor

Descriptor data structure.

Descriptors are basic data structure used throughout PSD files. Descriptor is one kind of serialization protocol for data objects, and enum classes in psd_tools.terminology or bytes indicates what kind of descriptor it is.

The class ID can be pre-defined enum if the tag is 4-byte length or plain bytes if the length is arbitrary. They depend on the internal version of Adobe Photoshop but the detail is unknown.

Pretty printing is the best approach to check the descriptor content:

from IPython.pretty import pprint
pprint(descriptor)


Alias

Alias structure equivalent to RawData.

Bool

Bool structure.
bool value


Class

Class structure.
str value

bytes in Klass


Class1

Class structure equivalent to Class.

Class2

Class structure equivalent to Class.

Class3

Class structure equivalent to Class.

Descriptor

Dict-like descriptor structure.

Key values can be 4-character bytes in Key or arbitrary length bytes. Supports direct access by Key.

Example:

from psd_tools.terminology import Key
descriptor[Key.Enabled]
for key in descriptor:


    print(descriptor[key])


str

bytes in Klass


Double

Double structure.
float value


Enumerated

Enum structure.
bytes in Type

bytes in Enum

Get enum name.


EnumeratedReference

Enumerated reference structure.
str value

bytes in Klass

bytes in Type

bytes in Enum


GlobalObject

Global object structure equivalent to Descriptor.

Identifier

Identifier equivalent to Integer.

Index

Index equivalent to Integer.

Integer

Integer structure.
int value


LargeInteger

LargeInteger structure.
int value


List

List structure.

Example:

for item in list_value:


    print(item)



Name

Name structure (Undocumented).
str

bytes in Klass

str


ObjectArray

Object array structure almost equivalent to Descriptor.
int value

str value

bytes in Klass


Property

Property structure.
str value

bytes in Klass

bytes in Key


Offset

Offset structure.
str value

bytes in Klass

int value


Path

Undocumented path structure equivalent to RawData.

RawData

RawData structure.
bytes value


Reference

Reference structure equivalent to List.

String

String structure.
str value


UnitFloat

Unit float structure.
unit of the value in Unit or Enum

float value


UnitFloats

Unit floats structure.
unit of the value in Unit or Enum

List of float values


psd_tools.psd.engine_data

EngineData structure.

PSD file embeds text formatting data in its own markup language referred EngineData. The format looks like the following:

<<


  /EngineDict


  <<


    /Editor


    <<


      /Text (˛ˇMake a change and save.)


    >>


  >>


  /Font


  <<


    /Name (˛ˇHelveticaNeue-Light)


    /FillColor


    <<


      /Type 1


      /Values [ 1.0 0.0 0.0 0.0 ]


    >>


    /StyleSheetSet [


    <<


      /Name (˛ˇNormal RGB)


    >>


    ]


  >>
>>


EngineData

Dict-like element.

TYPE_TOOL_OBJECT_SETTING tagged block contains this object in its descriptor.


EngineData2

Dict-like element.

TEXT_ENGINE_DATA tagged block has this object.


Bool

Bool element.

Dict

Dict-like element.

Float

Float element.

Integer

Integer element.

List

List-like element.

Property

Property element.

String

String element.

psd_tools.psd.effects_layer

Effects layer structure.

Note the structures in this module is obsolete and object-based layer effects are stored in tagged blocks.

EffectsLayer

Dict-like EffectsLayer structure. See psd_tools.constants.EffectOSType for available keys.


CommonStateInfo

Effects layer common state info.



ShadowInfo

Effects layer shadow info.












OuterGlowInfo

Effects layer outer glow info.









InnerGlowInfo

Effects layer inner glow info.










BevelInfo

Effects layer bevel info.
















SolidFillInfo

Effects layer inner glow info.







psd_tools.psd.filter_effects

Filter effects structure.

FilterEffects

List-like FilterEffects structure. See FilterEffect.


FilterEffect

FilterEffect structure.





List of FilterEffectChannel.

See FilterEffectExtra.


FilterEffectChannel

FilterEffectChannel structure.




FilterEffectExtra

FilterEffectExtra structure.





psd_tools.psd.header

File header structure.

FileHeader

Header section of the PSD file.

Example:

from psd_tools.psd.header import FileHeader
from psd_tools.constants import ColorMode
header = FileHeader(channels=2, height=359, width=400, depth=8,


                    color_mode=ColorMode.GRAYSCALE)


Signature: always equal to b'8BPS'.

Version number. PSD is 1, and PSB is 2.

The number of channels in the image, including any user-defined alpha channel.

The height of the image in pixels.

The width of the image in pixels.

The number of bits per channel.

The color mode of the file. See ColorMode


psd_tools.psd.image_data

Image data section structure.

ImageData corresponds to the last section of the PSD/PSB file where a composited image is stored. When the file does not contain layers, this is the only place pixels are saved.

ImageData

Merged channel image data.
See Compression.

bytes as compressed in the compression flag.

Get decompressed data.
header -- See FileHeader.
list of bytes corresponding each channel.


Create a new image data object.
  • header -- FileHeader.
  • compression -- compression type.
  • color -- default color. int or iterable for channel length.



Set raw data and compress.
  • data -- list of raw data bytes corresponding channels.
  • compression -- compression type, see Compression.
  • header -- See FileHeader.

length of compressed data.



psd_tools.psd.image_resources

Image resources section structure. Image resources are used to store non-pixel data associated with images, such as pen tool paths or slices.

See Resource to check available resource names.

Example:

from psd_tools.constants import Resource
version_info = psd.image_resources.get_data(Resource.VERSION_INFO)


The following resources are plain bytes:

Resource.OBSOLETE1: 1000
Resource.MAC_PRINT_MANAGER_INFO: 1001
Resource.MAC_PAGE_FORMAT_INFO: 1002
Resource.OBSOLETE2: 1003
Resource.DISPLAY_INFO_OBSOLETE: 1007
Resource.BORDER_INFO: 1009
Resource.DUOTONE_IMAGE_INFO: 1018
Resource.EFFECTIVE_BW: 1019
Resource.OBSOLETE3: 1020
Resource.EPS_OPTIONS: 1021
Resource.QUICK_MASK_INFO: 1022
Resource.OBSOLETE4: 1023
Resource.WORKING_PATH: 1025
Resource.OBSOLETE5: 1027
Resource.IPTC_NAA: 1028
Resource.IMAGE_MODE_RAW: 1029
Resource.JPEG_QUALITY: 1030
Resource.URL: 1035
Resource.COLOR_SAMPLERS_RESOURCE_OBSOLETE: 1038
Resource.ICC_PROFILE: 1039
Resource.SPOT_HALFTONE: 1043
Resource.JUMP_TO_XPEP: 1052
Resource.EXIF_DATA_1: 1058
Resource.EXIF_DATA_3: 1059
Resource.XMP_METADATA: 1060
Resource.CAPTION_DIGEST: 1061
Resource.ALTERNATE_DUOTONE_COLORS: 1066
Resource.ALTERNATE_SPOT_COLORS: 1067
Resource.HDR_TONING_INFO: 1070
Resource.PRINT_INFO_CS2: 1071
Resource.COLOR_SAMPLERS_RESOURCE: 1073
Resource.DISPLAY_INFO: 1077
Resource.MAC_NSPRINTINFO: 1084
Resource.WINDOWS_DEVMODE: 1085
Resource.PATH_INFO_N: 2000-2999
Resource.PLUGIN_RESOURCES_N: 4000-4999
Resource.IMAGE_READY_VARIABLES: 7000
Resource.IMAGE_READY_DATA_SETS: 7001
Resource.IMAGE_READY_DEFAULT_SELECTED_STATE: 7002
Resource.IMAGE_READY_7_ROLLOVER_EXPANDED_STATE: 7003
Resource.IMAGE_READY_ROLLOVER_EXPANDED_STATE: 7004
Resource.IMAGE_READY_SAVE_LAYER_SETTINGS: 7005
Resource.IMAGE_READY_VERSION: 7006
Resource.LIGHTROOM_WORKFLOW: 8000


ImageResources

Image resources section of the PSD file. Dict of ImageResource.
Get data from the image resources.

Shortcut for the following:

if key in image_resources:


    value = tagged_blocks[key].data



Create a new default image resouces.
ImageResources



ImageResource

Image resource block.
Binary signature, always b'8BIM'.

Unique identifier for the resource. See Resource.


The resource data.


AlphaIdentifiers

List of alpha identifiers.

AlphaNamesPascal

List of alpha names.

AlphaNamesUnicode

List of alpha names.

Byte

Byte element.

GridGuidesInfo

Grid and guides info structure.

HalftoneScreens

Halftone screens.

HalftoneScreen

Halftone screen.







Integer

Integer element.

LayerGroupEnabledIDs

Layer group enabled ids.

LayerGroupInfo

Layer group info list.

LayerSelectionIDs

Layer selection ids.

ShortInteger

Short integer element.

PascalString

Pascal string element.

PixelAspectRatio

Pixel aspect ratio.

PrintFlags

Print flags.

PrintFlagsInfo

Print flags info structure.





PrintScale

Print scale structure.





ResoulutionInfo

Resoulution info structure.







Slices

Slices resource.



SlicesV6

Slices resource version 6.




SliceV6

Slice element for version 6.





















ThumbnailResource

Thumbnail resource structure.









Get PIL Image.
PIL Image object.



ThumbnailResourceV4


TransferFunctions

Transfer functions.

TransferFunction

Transfer function

URLList

URL list structure.

URLItem

URL item.




VersionInfo

Version info structure.






psd_tools.psd.layer_and_mask

Layer and mask data structure.

LayerAndMaskInformation

Layer and mask information section.
See LayerInfo.

See GlobalLayerMaskInfo.

See TaggedBlocks.


LayerInfo

High-level organization of the layer information.
Layer count. If it is a negative number, its absolute value is the number of layers and the first alpha channel contains the transparency data for the merged result.

Information about each layer. See LayerRecords.

Channel image data. See ChannelImageData.


GlobalLayerMaskInfo

Global mask information.
Overlay color space (undocumented) and color components.

Opacity. 0 = transparent, 100 = opaque.

Kind. 0 = Color selected--i.e. inverted; 1 = Color protected; 128 = use value stored per layer. This value is preferred. The others are for backward compatibility with beta versions.


LayerRecords

List of layer records. See LayerRecord.

LayerRecord

Layer record.
Top position.

Left position.

Bottom position.

Right position.

List of ChannelInfo.

Blend mode signature b'8BIM'.

Blend mode key. See BlendMode.

Opacity, 0 = transparent, 255 = opaque.

Clipping, 0 = base, 1 = non-base. See Clipping.

See LayerFlags.

MaskData or None.

See LayerBlendingRanges.

Layer name.

See TaggedBlocks.

List of channel sizes: [(width, height)].

Height of the layer.

Width of the layer.


LayerFlags

Layer flags.

Note there are undocumented flags. Maybe photoshop version.





LayerBlendingRanges

Layer blending ranges.

All ranges contain 2 black values followed by 2 white values.

List of composite gray blend source and destination ranges.

List of channel source and destination ranges.


MaskData

Mask data.

Real user mask is a final composite mask of vector and pixel masks.

Top position.

Left position.

Bottom position.

Right position.

Default color. 0 or 255.

See MaskFlags.

MaskParameters or None.

Real user mask flags. See MaskFlags.

Real user mask background. 0 or 255.

Top position of real user mask.

Left position of real user mask.

Bottom position of real user mask.

Right position of real user mask.

Height of the mask.

Height of real user mask.

Width of real user mask.

Width of the mask.


MaskFlags

Mask flags.
Position relative to layer.

Layer mask disabled.

Invert layer mask when blending (Obsolete).

The user mask actually came from rendering other data.

The user and/or vector masks have parameters applied to them.


MaskParameters

Mask parameters.





ChannelInfo

Channel information.
Channel ID: 0 = red, 1 = green, etc.; -1 = transparency mask; -2 = user supplied layer mask, -3 real user supplied layer mask (when both a user mask and a vector mask are present). See ChannelID.

Length of the corresponding channel data.


ChannelImageData

List of channel data list.

This size of this list corresponds to the size of LayerRecords. Each item corresponds to the channels of each layer.

See ChannelDataList.


ChannelDataList

List of channel image data, corresponding to each color or alpha.

See ChannelData.


ChannelData

Channel data.
Compression type. See Compression.

Data.

Get decompressed channel data.
  • width -- width.
  • height -- height.
  • depth -- bit depth of the pixel.
  • version -- psd file version.

bytes


Set raw channel data and compress to store.
  • data -- raw data bytes to write.
  • compression -- compression type, see Compression.
  • width -- width.
  • height -- height.
  • depth -- bit depth of the pixel.
  • version -- psd file version.




psd_tools.psd.linked_layer

Linked layer structure.

LinkedLayers

List of LinkedLayer structure. See LinkedLayer.

LinkedLayer

LinkedLayer structure.















psd_tools.psd.patterns

Patterns structure.

Patterns

List of Pattern structure. See Pattern.

Pattern

Pattern structure.

See ColorMode

Size in tuple.

str name of the pattern.

ID of this pattern.

Color table if the mode is INDEXED.

See VirtualMemoryArrayList


VirtualMemoryArrayList

VirtualMemoryArrayList structure. Container of channels.

Tuple of int

List of VirtualMemoryArray


VirtualMemoryArray

VirtualMemoryArrayList structure, corresponding to each channel.






Get decompressed bytes.

Set bytes.


psd_tools.psd.tagged_blocks

Tagged block data structure.

Todo

Support the following tagged blocks: Tag.PATTERN_DATA, Tag.TYPE_TOOL_INFO, Tag.LAYER, Tag.ALPHA



TaggedBlocks

Dict of tagged block items.

See Tag for available keys.

Example:

from psd_tools.constants import Tag
# Iterate over fields
for key in tagged_blocks:


    print(key)
# Get a field
value = tagged_blocks.get_data(Tag.TYPE_TOOL_OBJECT_SETTING)



TaggedBlock

Layer tagged block with extra info.
4-character code. See Tag

Data.


Annotations

List of Annotation, see :py:class: .Annotation.



Annotation

Annotation structure.



Bytes

Bytes structure.


ChannelBlendingRestrictionsSetting

ChannelBlendingRestrictionsSetting structure.

List of restricted channel numbers (int).


FilterMask

FilterMask structure.



MetadataSettings

MetadataSettings structure.

MetadataSetting

MetadataSetting structure.

PixelSourceData2

PixelSourceData2 structure.

PlacedLayerData

PlacedLayerData structure.

ProtectedSetting

ProtectedSetting structure.

ReferencePoint

ReferencePoint structure.

SectionDividerSetting

SectionDividerSetting structure.




SheetColorSetting

SheetColorSetting value.

This setting represents color label in the layers panel in Photoshop UI.



SmartObjectLayerData

VersionedDescriptorBlock structure.




TypeToolObjectSetting

TypeToolObjectSetting structure.

Tuple of affine transform parameters (xx, xy, yx, yy, tx, ty).










UserMask

UserMask structure.




psd_tools.psd.vector

Vector mask, path, and stroke structure.

Path

List-like Path structure. Elements are either PathFillRule, InitialFillRule, ClipboardRecord, ClosedPath, or OpenPath.

Subpath

Subpath element. This is a list of Knot objects.

NOTE:

There are undocumented data associated with this structure.


int value indicating how multiple subpath should be combined:

1: Or (union), 2: Not-Or, 3: And (intersect), 0: Xor (exclude)

The first path element is applied to the background surface. Intersection does not have strokes.


int index that specifies corresponding origination object.

Returns whether if the path is closed or not.
bool.



Knot

Knot element consisting of 3 control points for Bezier curves.
(y, x) tuple of preceding control point in relative coordinates.

(y, x) tuple of anchor point in relative coordinates.

(y, x) tuple of leaving control point in relative coordinates.


ClipboardRecord

Clipboard record.
Top position in int

Left position in int

Bottom position in int

Right position in int

Resolution in int


PathFillRule

Path fill rule record, empty.

InitialFillRule

Initial fill rule record.
A value of 1 means that the fill starts with all pixels. The value will be either 0 or 1.


VectorMaskSetting

VectorMaskSetting structure.

List of Subpath objects.

Flag to indicate that the vector mask is disabled.

Flag to indicate that the vector mask is inverted.

Flag to indicate that the vector mask is not linked.


VectorStrokeContentSetting

Dict-like Descriptor-based structure. See Descriptor.



psd_tools.terminology

Constants for descriptor.

This file is automaticaly generated by tools/extract_terminology.py

Klass

Klass definitions extracted from PITerminology.h.

See https://www.adobe.com/devnet/photoshop/sdk.html

















BevelEmboss = b'ebbl'





BrightnessContrast = b'BrgC'










ChannelMixer = b'ChnM'







ColorBalance = b'ClrB'









Curves = b'Crvs'









DropShadow = b'DrSh'








Ellipse = b'Elps'















GradientFill = b'Grdf'

GradientMap = b'GdMp'









HalftoneScreen = b'HlfS'







HueSaturation = b'HStr'







InnerGlow = b'IrGl'

InnerShadow = b'IrSh'









Levels = b'Lvls'



Line = b'Ln '




Mask = b'Msk '






Offset = b'Ofst'


OuterGlow = b'OrGl'







Path = b'Path'



Pattern = b'PttR'















Posterize = b'Pstr'



Property = b'Prpr'







Rectangle = b'Rctn'




SelectiveColor = b'SlcC'
















Threshold = b'Thrs'












Enum

Enum definitions extracted from PITerminology.h.

See https://www.adobe.com/devnet/photoshop/sdk.html
































































BlackAndWhite = b'BanW'


































































































Ellipse = b'Elps'





































GradientFill = b'GrFl'



























HalftoneScreen = b'HlfS'






































































Line = b'Ln '















Mask = b'Msk '








































































Pattern = b'Ptrn'





























































































































































Threshold = b'Thrh'





















































































_16BitsPerPixel = b'16Bt'

_1BitPerPixel = b'OnBt'

_2BitsPerPixel = b'2Bts'

_32BitsPerPixel = b'32Bt'

_4BitsPerPixel = b'4Bts'

_5000 = b'5000'

_5500 = b'5500'

_6500 = b'6500'

_72Color = b'72Cl'

_72Gray = b'72Gr'

_7500 = b'7500'

_8BitsPerPixel = b'EghB'

_9300 = b'9300'

_None = b'None'


Event

Event definitions extracted from PITerminology.h.

See https://www.adobe.com/devnet/photoshop/sdk.html






















ChannelMixer = b'ChnM'






ColorBalance = b'ClrB'

















Curves = b'Crvs'














































GradientMap = b'GrMp'



Group = b'GrpL'



HalftoneScreen = b'HlfS'



HueSaturation = b'HStr'









Levels = b'Lvls'























Offset = b'Ofst'



















Posterize = b'Pstr'






















SelectiveColor = b'SlcC'




















Stroke = b'Strk'








Threshold = b'Thrs'



















_3DTransform = b'TdT '


Form

Form definitions extracted from PITerminology.h.

See https://www.adobe.com/devnet/photoshop/sdk.html

Class = b'Clss'

Enumerated = b'Enmr'

Identifier = b'Idnt'

Index = b'indx'

Offset = b'rele'

Property = b'prop'


Key

Key definitions extracted from PITerminology.h.

See https://www.adobe.com/devnet/photoshop/sdk.html

















































BevelEmboss = b'ebbl'


















































































Compression = b'Cmpr'




































































DropShadow = b'DrSh'






























Exposure = b'Exps'




















































































GradientFill = b'Grdf'




















Group = b'Grup'










HalftoneScreen = b'HlfS'


































InnerGlow = b'IrGl'


InnerShadow = b'IrSh'



























































Layers = b'Lyrs'







Levels = b'Lvls'









Line = b'Line'





































Name = b'Nm '





















Offset = b'Ofst'









OuterGlow = b'OrGl'






















Path = b'Path'



Pattern = b'Pttn'
































































































































































Threshold = b'Thsh'














TransferFunction = b'TrnF'











Type = b'Type'























































_3DAntiAlias = b'Alis'



Type

Type definitions extracted from PITerminology.h.

See https://www.adobe.com/devnet/photoshop/sdk.html













BlendMode = b'BlnM'






























































GlobalObject = b'GlbO'






















































RawData = b'tdta'






















UnitFloat = b'UntF'










Unit

Unit definitions extracted from PITerminology.h.

See https://www.adobe.com/devnet/photoshop/sdk.html








_None = b'#Nne'


INDICES AND TABLES

  • Index
  • Module Index
  • Search Page

AUTHOR

Kota Yamaguchi

COPYRIGHT

2024, Kota Yamaguchi

August 26, 2024 1.9.34