psd2pngs 1.0.0__tar.gz

psd2pngs-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 34j and contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

psd2pngs-1.0.0/PKG-INFO

@@ -0,0 +1,200 @@
+Metadata-Version: 2.4
+Name: psd2pngs
+Version: 1.0.0
+Summary: Convert a PSD file to PNG files while maintaining the layer hierarchy.
+Author: 34j
+License-Expression: MIT
+Project-URL: Bug Tracker, https://github.com/34j/psd2pngs/issues
+Project-URL: Changelog, https://github.com/34j/psd2pngs/blob/main/CHANGELOG.md
+Project-URL: documentation, https://psd2pngs.readthedocs.io
+Project-URL: repository, https://github.com/34j/psd2pngs
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Multimedia :: Graphics :: Graphics Conversion
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: click
+Requires-Dist: pillow
+Requires-Dist: psd-tools
+Requires-Dist: pyhumps
+Requires-Dist: tqdm
+Dynamic: license-file
+
+# psd2pngs
+
+<p align="center">
+  <a href="https://github.com/34j/psd2pngs/actions/workflows/ci.yml?query=branch%3Amain">
+    <img src="https://img.shields.io/github/actions/workflow/status/34j/psd2pngs/ci.yml?branch=main&label=CI&logo=github&style=flat-square" alt="CI Status">
+  </a>
+  <a href="https://psd2pngs.readthedocs.io">
+    <img src="https://img.shields.io/readthedocs/psd2pngs.svg?logo=read-the-docs&logoColor=fff&style=flat-square" alt="Documentation Status">
+  </a>
+</p>
+<p align="center">
+  <a href="https://codecov.io/gh/34j/psd2pngs">
+    <img src="https://img.shields.io/codecov/c/github/34j/psd2pngs.svg?logo=codecov&logoColor=fff&style=flat-square" alt="Test coverage percentage">
+  </a>
+  <a href="https://github.com/astral-sh/uv">
+    <img src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json" alt="uv">
+  </a>
+  <a href="https://github.com/astral-sh/ruff">
+    <img src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json" alt="Ruff">
+  </a>
+  <a href="https://github.com/j178/prek">
+    <img src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/j178/prek/master/docs/assets/badge-v0.json" alt="prek">
+  </a>
+</p>
+<p align="center">
+  <a href="https://pypi.org/project/psd2pngs/">
+    <img src="https://img.shields.io/pypi/v/psd2pngs.svg?logo=python&logoColor=fff&style=flat-square" alt="PyPI Version">
+  </a>
+  <img src="https://img.shields.io/pypi/pyversions/psd2pngs.svg?style=flat-square&logo=python&amp;logoColor=fff" alt="Supported Python versions">
+  <img src="https://img.shields.io/pypi/l/psd2pngs.svg?style=flat-square" alt="License">
+</p>
+
+---
+
+**Documentation**: <a href="https://psd2pngs.readthedocs.io" target="_blank">https://psd2pngs.readthedocs.io </a>
+
+**Source Code**: <a href="https://github.com/34j/psd2pngs" target="_blank">https://github.com/34j/psd2pngs </a>
+
+---
+
+Convert a PSD file to PNG files while maintaining the layer hierarchy.
+
+## Introduction
+
+psd2pngs converts a psd file to png files while maintaining the layer hierarchy and performing the appropriate renaming, using multiprocessing.
+You do not have to read this long docs, just download [![Executable](https://img.shields.io/badge/psd2pngs.exe-Click-darkblue)](https://github.com/34j/psd2pngs/releases) and open a psd file with it!
+
+## Example
+
+![Screenshot GIF](Example.gif)
+
+Note that this GIF is in fast forward.
+
+## Usage
+
+### Using as an app
+
+- Just open `.psd` file with this app. ([Executable version](https://github.com/34j/psd2pngs/releases) only.)
+- Alternatively, this app can also be used with command prompt.
+
+```shell
+> psd2pngs -h
+Usage: psd2pngs [OPTIONS] PSD_PATH
+
+Options:
+  -v, --version              Show the version and exit.
+  -o, --out PATH             Output directory path. If not specified, output
+                             to the same directory as the PSD file.
+  -s, --single-process       Force not to use multiprocessing.
+  -t, --tasks-count INTEGER  Number of tasks. Recommended to be less than or
+                             equal to the number of CPUs (32) because the
+                             process maximizes the use of CPUs.
+  -j, --json                 Output JSON file containing layer information in
+                             snake case.
+  -jc, --json-camel-case     Output JSON file containing layer information in
+                             camel case.
+  -h, -?, --help             Show this message and exit.
+```
+
+The type of content of Output JSON file (snake_case) is the following.
+
+```python
+class LayerInfo(NamedTuple):
+    local_path: str
+    name: str
+    safe_name: str
+    is_visible: bool
+    is_group: bool
+    children: "Iterable[LayerInfo]"
+```
+
+The type of content of Output JSON file (camelCase) is the following.
+
+```python
+class LayerInfo(NamedTuple):
+    localPath: str
+    name: str
+    safeName: str
+    isVisible: bool
+    isGroup: bool
+    children: "Iterable[LayerInfo]"
+```
+
+### Using as a module
+
+See the [documentation (readthedocs.io)](https://psd2pngs.readthedocs.io/).
+
+## Installation
+
+### Option 1. Executable version
+
+Download the latest release from [Releases](https://github.com/34j/psd2pngs/releases).
+
+### Option 2. Python version using pip install
+
+```shell
+py -m venv venv
+"./venv/Scripts/Activate.bat"
+pip install psd2pngs
+psd2pngs from.psd
+```
+
+### Option 3. Python version using git clone
+
+```shell
+git clone https://github.com/34j/psd2pngs.git
+cd ./psd2pngs
+py -m venv venv
+"./venv/Scripts/Activate.bat"
+pip install .
+python -m psd2pngs from.psd
+```
+
+### Option 4. Executable version - Compiling yourself using pip
+
+```shell
+py -m venv venv
+"./venv/Scripts/Activate.bat"
+pip install .
+pip install pyinstaller
+pyinstaller venv/Lib/site-packages/psd2pngs/__main__.py --onefile -n psd2pngs
+move "./dist/psd2pngs.exe" "./"
+./psd2pngs from.psd
+```
+
+### Option 5. Executable version - Compiling yourself using git
+
+```shell
+git clone https://github.com/34j/psd2pngs.git
+cd ./psd2pngs
+py -m venv venv
+"./venv/Scripts/Activate.bat"
+pip install .
+pip install pyinstaller
+pyinstaller src/psd2pngs/__main__.py --onefile -n psd2pngs
+move "./dist/psd2pngs.exe" "./"
+./psd2pngs from.psd
+```
+
+## 日本語の説明
+
+psd2pngsは、psdファイルをレイヤーの階層構造を維持したままpngファイルに変換し、適切なリネームを行うアプリケーションです。
+1ファイルにまとまったWindows用実行ファイル[`psd2pngs.exe`](https://github.com/34j/psd2pngs/releases)も配布しています。
+
+### インストール方法
+
+- [Releases](https://github.com/34j/psd2pngs/releases)から最新のリリースをダウンロードします。
+
+### 使い方
+
+- psdファイルを右クリックし、`プログラムから開く`を使ってこのアプリで開きます。

psd2pngs-1.0.0/README.md

@@ -0,0 +1,171 @@
+# psd2pngs
+
+<p align="center">
+  <a href="https://github.com/34j/psd2pngs/actions/workflows/ci.yml?query=branch%3Amain">
+    <img src="https://img.shields.io/github/actions/workflow/status/34j/psd2pngs/ci.yml?branch=main&label=CI&logo=github&style=flat-square" alt="CI Status">
+  </a>
+  <a href="https://psd2pngs.readthedocs.io">
+    <img src="https://img.shields.io/readthedocs/psd2pngs.svg?logo=read-the-docs&logoColor=fff&style=flat-square" alt="Documentation Status">
+  </a>
+</p>
+<p align="center">
+  <a href="https://codecov.io/gh/34j/psd2pngs">
+    <img src="https://img.shields.io/codecov/c/github/34j/psd2pngs.svg?logo=codecov&logoColor=fff&style=flat-square" alt="Test coverage percentage">
+  </a>
+  <a href="https://github.com/astral-sh/uv">
+    <img src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json" alt="uv">
+  </a>
+  <a href="https://github.com/astral-sh/ruff">
+    <img src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json" alt="Ruff">
+  </a>
+  <a href="https://github.com/j178/prek">
+    <img src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/j178/prek/master/docs/assets/badge-v0.json" alt="prek">
+  </a>
+</p>
+<p align="center">
+  <a href="https://pypi.org/project/psd2pngs/">
+    <img src="https://img.shields.io/pypi/v/psd2pngs.svg?logo=python&logoColor=fff&style=flat-square" alt="PyPI Version">
+  </a>
+  <img src="https://img.shields.io/pypi/pyversions/psd2pngs.svg?style=flat-square&logo=python&amp;logoColor=fff" alt="Supported Python versions">
+  <img src="https://img.shields.io/pypi/l/psd2pngs.svg?style=flat-square" alt="License">
+</p>
+
+---
+
+**Documentation**: <a href="https://psd2pngs.readthedocs.io" target="_blank">https://psd2pngs.readthedocs.io </a>
+
+**Source Code**: <a href="https://github.com/34j/psd2pngs" target="_blank">https://github.com/34j/psd2pngs </a>
+
+---
+
+Convert a PSD file to PNG files while maintaining the layer hierarchy.
+
+## Introduction
+
+psd2pngs converts a psd file to png files while maintaining the layer hierarchy and performing the appropriate renaming, using multiprocessing.
+You do not have to read this long docs, just download [![Executable](https://img.shields.io/badge/psd2pngs.exe-Click-darkblue)](https://github.com/34j/psd2pngs/releases) and open a psd file with it!
+
+## Example
+
+![Screenshot GIF](Example.gif)
+
+Note that this GIF is in fast forward.
+
+## Usage
+
+### Using as an app
+
+- Just open `.psd` file with this app. ([Executable version](https://github.com/34j/psd2pngs/releases) only.)
+- Alternatively, this app can also be used with command prompt.
+
+```shell
+> psd2pngs -h
+Usage: psd2pngs [OPTIONS] PSD_PATH
+
+Options:
+  -v, --version              Show the version and exit.
+  -o, --out PATH             Output directory path. If not specified, output
+                             to the same directory as the PSD file.
+  -s, --single-process       Force not to use multiprocessing.
+  -t, --tasks-count INTEGER  Number of tasks. Recommended to be less than or
+                             equal to the number of CPUs (32) because the
+                             process maximizes the use of CPUs.
+  -j, --json                 Output JSON file containing layer information in
+                             snake case.
+  -jc, --json-camel-case     Output JSON file containing layer information in
+                             camel case.
+  -h, -?, --help             Show this message and exit.
+```
+
+The type of content of Output JSON file (snake_case) is the following.
+
+```python
+class LayerInfo(NamedTuple):
+    local_path: str
+    name: str
+    safe_name: str
+    is_visible: bool
+    is_group: bool
+    children: "Iterable[LayerInfo]"
+```
+
+The type of content of Output JSON file (camelCase) is the following.
+
+```python
+class LayerInfo(NamedTuple):
+    localPath: str
+    name: str
+    safeName: str
+    isVisible: bool
+    isGroup: bool
+    children: "Iterable[LayerInfo]"
+```
+
+### Using as a module
+
+See the [documentation (readthedocs.io)](https://psd2pngs.readthedocs.io/).
+
+## Installation
+
+### Option 1. Executable version
+
+Download the latest release from [Releases](https://github.com/34j/psd2pngs/releases).
+
+### Option 2. Python version using pip install
+
+```shell
+py -m venv venv
+"./venv/Scripts/Activate.bat"
+pip install psd2pngs
+psd2pngs from.psd
+```
+
+### Option 3. Python version using git clone
+
+```shell
+git clone https://github.com/34j/psd2pngs.git
+cd ./psd2pngs
+py -m venv venv
+"./venv/Scripts/Activate.bat"
+pip install .
+python -m psd2pngs from.psd
+```
+
+### Option 4. Executable version - Compiling yourself using pip
+
+```shell
+py -m venv venv
+"./venv/Scripts/Activate.bat"
+pip install .
+pip install pyinstaller
+pyinstaller venv/Lib/site-packages/psd2pngs/__main__.py --onefile -n psd2pngs
+move "./dist/psd2pngs.exe" "./"
+./psd2pngs from.psd
+```
+
+### Option 5. Executable version - Compiling yourself using git
+
+```shell
+git clone https://github.com/34j/psd2pngs.git
+cd ./psd2pngs
+py -m venv venv
+"./venv/Scripts/Activate.bat"
+pip install .
+pip install pyinstaller
+pyinstaller src/psd2pngs/__main__.py --onefile -n psd2pngs
+move "./dist/psd2pngs.exe" "./"
+./psd2pngs from.psd
+```
+
+## 日本語の説明
+
+psd2pngsは、psdファイルをレイヤーの階層構造を維持したままpngファイルに変換し、適切なリネームを行うアプリケーションです。
+1ファイルにまとまったWindows用実行ファイル[`psd2pngs.exe`](https://github.com/34j/psd2pngs/releases)も配布しています。
+
+### インストール方法
+
+- [Releases](https://github.com/34j/psd2pngs/releases)から最新のリリースをダウンロードします。
+
+### 使い方
+
+- psdファイルを右クリックし、`プログラムから開く`を使ってこのアプリで開きます。

psd2pngs-1.0.0/pyproject.toml

@@ -0,0 +1,60 @@
+[build-system]
+build-backend = "setuptools.build_meta"
+requires = [ "setuptools>=77.0.3" ]
+
+[project]
+name = "psd2pngs"
+version = "1.0.0"
+description = "Convert a PSD file to PNG files while maintaining the layer hierarchy."
+readme = "README.md"
+license = "MIT"
+authors = [
+  { name = "34j" },
+]
+requires-python = ">=3.12"
+classifiers = [
+  "Development Status :: 5 - Production/Stable",
+  "Intended Audience :: End Users/Desktop",
+  "Natural Language :: English",
+  "Operating System :: OS Independent",
+  "Programming Language :: Python :: 3 :: Only",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
+  "Programming Language :: Python :: 3.14",
+  "Topic :: Multimedia :: Graphics :: Graphics Conversion",
+]
+dependencies = [
+  "click",
+  "pillow",
+  "psd-tools",
+  "pyhumps",
+  "tqdm",
+]
+urls."Bug Tracker" = "https://github.com/34j/psd2pngs/issues"
+urls.Changelog = "https://github.com/34j/psd2pngs/blob/main/CHANGELOG.md"
+urls.documentation = "https://psd2pngs.readthedocs.io"
+urls.repository = "https://github.com/34j/psd2pngs"
+scripts.psd2pngs = "psd2pngs.__main__:psd2pngs"
+
+[dependency-groups]
+dev = [
+  "coverage",
+  "packaging-34j[test]",
+  "pytest",
+  "pytest-cov",
+  "ty",
+]
+docs = [
+  "packaging-34j[docs]",
+]
+
+[tool.ruff]
+extend = ".venv/ruff.toml"
+lint.per-file-ignores."src/psd2pngs/**/*.py" = [ "ALL" ]
+lint.per-file-ignores."tests/**/*.py" = [ "ALL" ]
+
+[tool.pyproject-fmt]
+max_supported_python = "3.14"
+
+[tool.ty]
+terminal.error-on-warning = true

psd2pngs-1.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

psd2pngs-1.0.0/src/psd2pngs/__init__.py

@@ -0,0 +1,4 @@
+from .conversion import convert
+from .version import __version__
+
+__all__ = ["__version__", "convert"]

psd2pngs-1.0.0/src/psd2pngs/__main__.py

@@ -0,0 +1,61 @@
+import multiprocessing
+
+import click
+
+from psd2pngs.conversion import convert
+from psd2pngs.version import __version__
+
+_CONTEXT_SETTINGS = {"help_option_names": ["-?", "-h", "--help"]}
+
+
+@click.command(context_settings=_CONTEXT_SETTINGS)
+@click.version_option(__version__, "-v", "--version", prog_name="psd2pngs")
+@click.argument("psd_path", type=click.Path(exists=True))
+@click.option(
+    "--out",
+    "-o",
+    "out_dir_path",
+    type=click.Path(exists=True),
+    default=None,
+    help="Output directory path. If not specified, output to the same directory as the PSD file.",
+)
+@click.option("--single-process", "-s", is_flag=True, help="Force not to use multiprocessing.")
+@click.option(
+    "--tasks-count",
+    "-t",
+    "n_tasks",
+    type=int,
+    default=multiprocessing.cpu_count(),
+    help=f"Number of tasks. Recommended to be less than or equal to the number of CPUs ({multiprocessing.cpu_count()}) because the process maximizes the use of CPUs.",
+)
+@click.option(
+    "--json",
+    "-j",
+    "use_json",
+    is_flag=True,
+    help="Output JSON file containing layer information in snake case.",
+)
+@click.option(
+    "--json-camel-case",
+    "-jc",
+    "use_json_camel_case",
+    is_flag=True,
+    help="Output JSON file containing layer information in camel case.",
+)
+@click.option(
+    "--json-only",
+    "-jo",
+    "json_only",
+    is_flag=True,
+    help="Output JSON file only.",
+)
+def psd2pngs(*args, **kwargs) -> None:
+    """This function should be called from the command line."""
+    convert(*args, **kwargs)
+
+
+# This seems to be obvious, but without this, the program will loop infinitely when multiprocessing is used.
+if __name__ == "__main__":
+    # For pyinstaller to work when multiprocessing is used. This should be called HERE, not anywhere else.
+    multiprocessing.freeze_support()
+    psd2pngs()

psd2pngs-1.0.0/src/psd2pngs/conversion.py

@@ -0,0 +1,140 @@
+import concurrent.futures
+import json
+import multiprocessing
+from logging import DEBUG, StreamHandler, getLogger
+from pathlib import Path
+
+import humps
+import numpy as np
+from psd_tools import PSDImage
+from tqdm import tqdm
+
+from psd2pngs.layer_info import get_layer_info
+from psd2pngs.layer_save import save_layer, save_some_layers, search_all_layers
+from psd2pngs.unpack import unpack_nested_namedtuple
+
+
+def convert(
+    psd_path: str | Path,
+    out_dir_path: str | Path | None = None,
+    single_process: bool = False,
+    n_tasks: int = multiprocessing.cpu_count(),
+    use_json: bool = False,
+    use_json_camel_case: bool = False,
+    json_only: bool = False,
+) -> None:
+    """Convert a PSD file to multiple PNG files.
+    When multiprocessing, since pickling Layers are very slow, each process will open the PSD file separately.
+
+    Parameters
+    ----------
+    psd_path : str
+        Path to the PSD file.
+    out_dir_path : Optional[str], optional
+        Output directory, by default None
+    single_process : bool, optional
+        Do not use multiprocessing, by default False
+    n_tasks : int, optional
+        Number of tasks when multiprocessing is used, by default multiprocessing.cpu_count() (Number of CPU Threads)
+    use_json : bool, optional
+        Whether to output a json file (snake_case), by default False
+    use_json_camel_case : bool, optional
+        Whether to output a json file (camelCase), by default False
+    json_only : bool, optional
+        Only generates a json file and do not convert the file, by default False
+
+    Raises
+    ------
+    ValueError
+        Raises if the suffix of the PSD file is not ".psd".
+    ValueError
+        Raises if use_json and use_json_camel_case are both True.
+    ValueError
+        Raises if use_json and use_json_camel_case are both False but json_only is True.
+
+    """
+    # Check paths
+    psd_path_ = Path(psd_path).absolute()
+    out_dir_path_ = psd_path_.parent
+    if out_dir_path is not None:
+        out_dir_path_ = Path(out_dir_path).absolute()
+    if psd_path_.suffix != ".psd":
+        raise ValueError("The suffix of psd_path must be .psd")
+
+    # Check json options
+    if use_json and use_json_camel_case:
+        raise ValueError("Cannot use both --json and --json-camel-case.")
+    if json_only and not (use_json or use_json_camel_case):
+        raise ValueError("Cannot use --json-only without --json or --json-camel-case.")
+
+    # Open the PSD file
+    psd = PSDImage.open(psd_path_)
+
+    # Create output directory
+    out_dir_path_ = out_dir_path_.joinpath(psd_path_.stem)
+    out_dir_path_.mkdir(parents=True, exist_ok=True)
+
+    # Get and configure logger
+    logger = getLogger(__name__)
+    logger.addHandler(StreamHandler())
+    logger.setLevel(DEBUG)
+
+    # validate values
+    if n_tasks > multiprocessing.cpu_count():
+        logger.warning("--tasks-count is larger than the number of CPUs.")
+
+    # search all layers
+    logger.info("Searching all layers...")
+    all_layers = list(tqdm(search_all_layers(psd, out_dir_path_), unit=" layer(s) found"))
+
+    # save json files
+    if use_json or use_json_camel_case:
+        logger.info("Saving JSON file...")
+        json_path = out_dir_path_.joinpath(psd_path_.stem + ".json")
+        layer_info = unpack_nested_namedtuple(get_layer_info(psd))
+        if use_json_camel_case:
+            layer_info = humps.camelize(layer_info)  # type: ignore
+        with Path(json_path).open("w", encoding="utf-8") as f:
+            json.dump(layer_info, f, indent=4, ensure_ascii=False)
+
+    if json_only:
+        return
+
+    # save layers
+    logger.info("Saving layers...")
+
+    if not single_process:
+        # Use multiprocessing
+        logger.info("Using multiprocessing...")
+        with concurrent.futures.ProcessPoolExecutor() as executor:
+            tasks = []
+
+            # Calculate the number of layers that should be processed per task
+            n_layers = len(all_layers)
+            n_layers_per_task = np.ceil(n_layers / n_tasks).astype(int)
+
+            for i in range(n_tasks):
+                # Calculate the indcies of the layers that should be processed in this task
+                indcies = range(
+                    i * n_layers_per_task,
+                    np.min([(i + 1) * n_layers_per_task, n_layers]),
+                )
+
+                # Create and append task
+                tasks.append(executor.submit(save_some_layers, psd_path_, out_dir_path_, indcies))
+
+            # Wait for all tasks to finish. As soon as one task finishes, tqdm progress bar will update.
+            [
+                future.result()
+                for future in tqdm(
+                    concurrent.futures.as_completed(tasks),
+                    total=len(tasks),
+                    unit=" process(es)",
+                )
+            ]
+    else:
+        # Use single process
+        logger.info("Using single process...")
+
+        for layer_info in tqdm(all_layers, unit="file(s)"):
+            save_layer(psd.size, layer_info)

psd2pngs-1.0.0/src/psd2pngs/layer_info.py

@@ -0,0 +1,75 @@
+from collections.abc import Iterable
+from pathlib import Path
+from typing import NamedTuple
+
+from psd_tools import PSDImage
+
+from psd2pngs.safe_name import get_safe_name
+
+
+class LayerInfo(NamedTuple):
+    """Layer information."""
+
+    local_path: str
+    """The local path to the layer. The file name is safe_name.png."""
+    name: str
+    """The name of the layer."""
+    safe_name: str
+    """The safe name (which could be used as a file name) of the layer."""
+    is_visible: bool
+    """Whether the layer is visible."""
+    is_group: bool
+    """Whether the layer is a group."""
+    children: "Iterable[LayerInfo]"
+    """LayerInfos of the child layers. Empty list if not a group.
+    """
+
+
+def get_layer_info(layer: PSDImage, current_local_path: Path = Path()) -> LayerInfo:
+    """Get LayerInfo for the given layer. Recursively get LayerInfo for all children.
+
+    Parameters
+    ----------
+    layer : PSDImage
+        The base layer.
+    current_local_path : Path, optional
+        The base path to use for LayerInfo["local_path"], by default Path("")
+
+    Returns
+    -------
+    LayerInfo
+        The LayerInfo for the given layer.
+
+    """
+    # get names
+    name = layer.name
+    safe_name = get_safe_name(name)
+
+    # get visibility
+    is_visible = layer.is_visible()
+    is_group = layer.is_group()
+
+    # avoid to create 'Root' folder because it is just disruptive
+    if layer.kind == "psdimage":
+        local_path = current_local_path
+    else:
+        local_path = current_local_path.joinpath(get_safe_name(layer.name))
+
+    # add suffix
+    if not is_group:
+        local_path = local_path.with_suffix(".png")
+
+    # recursively get LayerInfo for all children
+    children = []
+    if is_group:
+        children = [get_layer_info(child, local_path) for child in layer]  # ty: ignore[invalid-argument-type]
+
+    # return LayerInfo
+    return LayerInfo(
+        local_path=str(local_path),
+        name=name,
+        safe_name=safe_name,
+        is_visible=is_visible,
+        is_group=is_group,
+        children=children,
+    )

psd2pngs-1.0.0/src/psd2pngs/layer_save.py

@@ -0,0 +1,116 @@
+from collections.abc import Generator, Iterable
+from pathlib import Path
+from typing import NamedTuple
+
+from PIL import Image
+from psd_tools import PSDImage
+from psd_tools.api.layers import Layer
+
+from psd2pngs.safe_name import get_safe_name
+
+
+class ImageLayerInfo(NamedTuple):
+    """Layer and.
+
+    Parameters
+    ----------
+    absolute_path: Path
+        The absolute path to output the image.
+    layer: Layer
+        The layer to output.
+
+    """
+
+    absolute_path: Path
+    """The absolute path to output the image.
+    """
+    layer: Layer
+    """The layer to output.
+    """
+
+
+def search_all_layers(
+    layer: Layer | PSDImage, current_absolute_path: Path
+) -> Generator[ImageLayerInfo, None, None]:
+    """Get all ImageLayerInfos under the given layer. Recursively get all ImageLayerInfos for all children.
+
+    Parameters
+    ----------
+    layer : Layer
+        The base layer.
+    current_absolute_path : Path
+        The base absolute path to use for ImageLayerInfo["absolute_path"]
+
+    Yields
+    ------
+    Generator[ImageLayerInfo, None, None]
+        ImageLayerInfos for all layers.
+
+    """
+    # avoid to create 'Root' folder because it is just disruptive
+    if layer.kind == "psdimage":
+        absolute_path = current_absolute_path
+    else:
+        layer_safe_name = get_safe_name(layer.name)
+        absolute_path = current_absolute_path.joinpath(layer_safe_name)
+
+    if layer.is_group():
+        # create folder for group
+        absolute_path.mkdir(parents=True, exist_ok=True)
+
+        # recursively get all ImageLayerInfos for all children
+        for child in layer:  # type: ignore
+            yield from search_all_layers(child, absolute_path)
+    else:
+        # add suffix
+        absolute_path = absolute_path.with_suffix(".png")
+        # yield ImageLayerInfo
+        yield ImageLayerInfo(absolute_path=absolute_path, layer=layer)  # ty: ignore[invalid-argument-type]
+
+
+def save_layer(image_size: tuple[int, int], layer_info: ImageLayerInfo) -> None:
+    """Save the given layer (layer_info['layer']) to the given path (layer_info['absolute_path']) using PIL.
+
+    Parameters
+    ----------
+    image_size : tuple[int, int]
+        The size of the root layer (any layer which you want it to be based on). psd.size is Recommended.
+    layer_info : ImageLayerInfo
+        The layer and absolute path to save the layer to.
+
+    """
+    # make sure that the size and position of the layer is maintained
+    with Image.new("RGBA", image_size, (0, 0, 0, 0)) as img:
+        # convert to PIL.Image
+        img_pil = layer_info.layer.topil()
+        if img_pil is not None:
+            with img_pil:
+                # paste the layer onto the image to maintain the position
+                img.paste(img_pil, layer_info.layer.offset)
+                img.save(layer_info.absolute_path)
+
+
+def save_some_layers(psd_path: Path, out_dir_path: Path, layer_indcies: Iterable[int]) -> None:
+    """Open the PSD file and save the given layers to the given path.
+    The expected use case of this function is to use as a multiprocessing function.
+    (Because heavy layers do not have to be pickled.).
+
+    Parameters
+    ----------
+    psd_path : Path
+        The path to the PSD file.
+    out_dir_path : Path
+        The base absolute path to create a folder in which layers will be saved.
+    layer_indcies : Iterable[int]
+        Indcies (for search_all_layers()) of the layers to save.
+
+    """
+    # open the PSD file
+    psd = PSDImage.open(psd_path)
+
+    # search layers
+    image_layer_infos = list(search_all_layers(psd, out_dir_path))
+
+    # save specified layers
+    for i in layer_indcies:
+        save_layer(psd.size, image_layer_infos[i])

psd2pngs-1.0.0/src/psd2pngs/safe_name.py

@@ -0,0 +1,16 @@
+def get_safe_name(name: str) -> str:
+    """Get a safe name that could be used as a file name for the given name.
+    '*' will be replaced with '-' and the rest will be replaced with '_'. (For better compatibility with PSDToolKit (well-known AviUtl Plugin)).
+
+    Parameters
+    ----------
+    name : str
+        The name to get a safe name for.
+
+    Returns
+    -------
+    str
+        The safe name.
+
+    """
+    return name.translate(str.maketrans('*\\/:?"<>| ', "-_________"))

psd2pngs-1.0.0/src/psd2pngs/unpack.py

@@ -0,0 +1,51 @@
+from collections.abc import Iterable, Mapping
+
+
+def isnamedtupleinstance(obj: object) -> bool:
+    """Check if the given object is a namedtuple.
+
+    Parameters
+    ----------
+    x : object
+        object to check.
+
+    Returns
+    -------
+    bool
+        True if the given object is a namedtuple.
+
+    """
+    type_ = type(obj)
+    bases = type_.__bases__
+    if len(bases) != 1 or bases[0] != tuple:
+        return False
+    fields = getattr(type_, "_fields", None)
+    if not isinstance(fields, tuple):
+        return False
+    return all(type(i) == str for i in fields)
+
+
+def unpack_nested_namedtuple(obj: object) -> object:
+    """Unpack a nested namedtuple to a dict.
+
+    Parameters
+    ----------
+    obj : object
+        object to unpack.
+
+    Returns
+    -------
+    object
+        Unpacked object.
+
+    """
+    if isnamedtupleinstance(obj):
+        assert hasattr(obj, "_asdict")
+        return {key: unpack_nested_namedtuple(value) for key, value in obj._asdict().items()}  # ty: ignore[call-non-callable]
+    if isinstance(obj, Mapping):
+        return {key: unpack_nested_namedtuple(value) for key, value in obj.items()}
+    if isinstance(obj, Iterable) and not isinstance(obj, str):
+        if hasattr(obj, "__init__"):
+            return type(obj)([unpack_nested_namedtuple(value) for value in obj])  # ty: ignore[too-many-positional-arguments]
+        return [unpack_nested_namedtuple(value) for value in obj]
+    return obj

psd2pngs-1.0.0/src/psd2pngs/version.py

@@ -0,0 +1,3 @@
+"""Version of psd2pngs."""
+
+__version__ = "1.2.4"

psd2pngs-1.0.0/src/psd2pngs.egg-info/PKG-INFO

@@ -0,0 +1,200 @@
+Metadata-Version: 2.4
+Name: psd2pngs
+Version: 1.0.0
+Summary: Convert a PSD file to PNG files while maintaining the layer hierarchy.
+Author: 34j
+License-Expression: MIT
+Project-URL: Bug Tracker, https://github.com/34j/psd2pngs/issues
+Project-URL: Changelog, https://github.com/34j/psd2pngs/blob/main/CHANGELOG.md
+Project-URL: documentation, https://psd2pngs.readthedocs.io
+Project-URL: repository, https://github.com/34j/psd2pngs
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Multimedia :: Graphics :: Graphics Conversion
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: click
+Requires-Dist: pillow
+Requires-Dist: psd-tools
+Requires-Dist: pyhumps
+Requires-Dist: tqdm
+Dynamic: license-file
+
+# psd2pngs
+
+<p align="center">
+  <a href="https://github.com/34j/psd2pngs/actions/workflows/ci.yml?query=branch%3Amain">
+    <img src="https://img.shields.io/github/actions/workflow/status/34j/psd2pngs/ci.yml?branch=main&label=CI&logo=github&style=flat-square" alt="CI Status">
+  </a>
+  <a href="https://psd2pngs.readthedocs.io">
+    <img src="https://img.shields.io/readthedocs/psd2pngs.svg?logo=read-the-docs&logoColor=fff&style=flat-square" alt="Documentation Status">
+  </a>
+</p>
+<p align="center">
+  <a href="https://codecov.io/gh/34j/psd2pngs">
+    <img src="https://img.shields.io/codecov/c/github/34j/psd2pngs.svg?logo=codecov&logoColor=fff&style=flat-square" alt="Test coverage percentage">
+  </a>
+  <a href="https://github.com/astral-sh/uv">
+    <img src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json" alt="uv">
+  </a>
+  <a href="https://github.com/astral-sh/ruff">
+    <img src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json" alt="Ruff">
+  </a>
+  <a href="https://github.com/j178/prek">
+    <img src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/j178/prek/master/docs/assets/badge-v0.json" alt="prek">
+  </a>
+</p>
+<p align="center">
+  <a href="https://pypi.org/project/psd2pngs/">
+    <img src="https://img.shields.io/pypi/v/psd2pngs.svg?logo=python&logoColor=fff&style=flat-square" alt="PyPI Version">
+  </a>
+  <img src="https://img.shields.io/pypi/pyversions/psd2pngs.svg?style=flat-square&logo=python&amp;logoColor=fff" alt="Supported Python versions">
+  <img src="https://img.shields.io/pypi/l/psd2pngs.svg?style=flat-square" alt="License">
+</p>
+
+---
+
+**Documentation**: <a href="https://psd2pngs.readthedocs.io" target="_blank">https://psd2pngs.readthedocs.io </a>
+
+**Source Code**: <a href="https://github.com/34j/psd2pngs" target="_blank">https://github.com/34j/psd2pngs </a>
+
+---
+
+Convert a PSD file to PNG files while maintaining the layer hierarchy.
+
+## Introduction
+
+psd2pngs converts a psd file to png files while maintaining the layer hierarchy and performing the appropriate renaming, using multiprocessing.
+You do not have to read this long docs, just download [![Executable](https://img.shields.io/badge/psd2pngs.exe-Click-darkblue)](https://github.com/34j/psd2pngs/releases) and open a psd file with it!
+
+## Example
+
+![Screenshot GIF](Example.gif)
+
+Note that this GIF is in fast forward.
+
+## Usage
+
+### Using as an app
+
+- Just open `.psd` file with this app. ([Executable version](https://github.com/34j/psd2pngs/releases) only.)
+- Alternatively, this app can also be used with command prompt.
+
+```shell
+> psd2pngs -h
+Usage: psd2pngs [OPTIONS] PSD_PATH
+
+Options:
+  -v, --version              Show the version and exit.
+  -o, --out PATH             Output directory path. If not specified, output
+                             to the same directory as the PSD file.
+  -s, --single-process       Force not to use multiprocessing.
+  -t, --tasks-count INTEGER  Number of tasks. Recommended to be less than or
+                             equal to the number of CPUs (32) because the
+                             process maximizes the use of CPUs.
+  -j, --json                 Output JSON file containing layer information in
+                             snake case.
+  -jc, --json-camel-case     Output JSON file containing layer information in
+                             camel case.
+  -h, -?, --help             Show this message and exit.
+```
+
+The type of content of Output JSON file (snake_case) is the following.
+
+```python
+class LayerInfo(NamedTuple):
+    local_path: str
+    name: str
+    safe_name: str
+    is_visible: bool
+    is_group: bool
+    children: "Iterable[LayerInfo]"
+```
+
+The type of content of Output JSON file (camelCase) is the following.
+
+```python
+class LayerInfo(NamedTuple):
+    localPath: str
+    name: str
+    safeName: str
+    isVisible: bool
+    isGroup: bool
+    children: "Iterable[LayerInfo]"
+```
+
+### Using as a module
+
+See the [documentation (readthedocs.io)](https://psd2pngs.readthedocs.io/).
+
+## Installation
+
+### Option 1. Executable version
+
+Download the latest release from [Releases](https://github.com/34j/psd2pngs/releases).
+
+### Option 2. Python version using pip install
+
+```shell
+py -m venv venv
+"./venv/Scripts/Activate.bat"
+pip install psd2pngs
+psd2pngs from.psd
+```
+
+### Option 3. Python version using git clone
+
+```shell
+git clone https://github.com/34j/psd2pngs.git
+cd ./psd2pngs
+py -m venv venv
+"./venv/Scripts/Activate.bat"
+pip install .
+python -m psd2pngs from.psd
+```
+
+### Option 4. Executable version - Compiling yourself using pip
+
+```shell
+py -m venv venv
+"./venv/Scripts/Activate.bat"
+pip install .
+pip install pyinstaller
+pyinstaller venv/Lib/site-packages/psd2pngs/__main__.py --onefile -n psd2pngs
+move "./dist/psd2pngs.exe" "./"
+./psd2pngs from.psd
+```
+
+### Option 5. Executable version - Compiling yourself using git
+
+```shell
+git clone https://github.com/34j/psd2pngs.git
+cd ./psd2pngs
+py -m venv venv
+"./venv/Scripts/Activate.bat"
+pip install .
+pip install pyinstaller
+pyinstaller src/psd2pngs/__main__.py --onefile -n psd2pngs
+move "./dist/psd2pngs.exe" "./"
+./psd2pngs from.psd
+```
+
+## 日本語の説明
+
+psd2pngsは、psdファイルをレイヤーの階層構造を維持したままpngファイルに変換し、適切なリネームを行うアプリケーションです。
+1ファイルにまとまったWindows用実行ファイル[`psd2pngs.exe`](https://github.com/34j/psd2pngs/releases)も配布しています。
+
+### インストール方法
+
+- [Releases](https://github.com/34j/psd2pngs/releases)から最新のリリースをダウンロードします。
+
+### 使い方
+
+- psdファイルを右クリックし、`プログラムから開く`を使ってこのアプリで開きます。

psd2pngs-1.0.0/src/psd2pngs.egg-info/SOURCES.txt

@@ -0,0 +1,19 @@
+LICENSE
+README.md
+pyproject.toml
+src/psd2pngs/__init__.py
+src/psd2pngs/__main__.py
+src/psd2pngs/conversion.py
+src/psd2pngs/layer_info.py
+src/psd2pngs/layer_save.py
+src/psd2pngs/safe_name.py
+src/psd2pngs/unpack.py
+src/psd2pngs/version.py
+src/psd2pngs.egg-info/PKG-INFO
+src/psd2pngs.egg-info/SOURCES.txt
+src/psd2pngs.egg-info/dependency_links.txt
+src/psd2pngs.egg-info/entry_points.txt
+src/psd2pngs.egg-info/requires.txt
+src/psd2pngs.egg-info/top_level.txt
+tests/test_convert.py
+tests/test_multiprocessing.py

psd2pngs-1.0.0/src/psd2pngs.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

psd2pngs-1.0.0/src/psd2pngs.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+psd2pngs = psd2pngs.__main__:psd2pngs

psd2pngs-1.0.0/src/psd2pngs.egg-info/requires.txt

@@ -0,0 +1,5 @@
+click
+pillow
+psd-tools
+pyhumps
+tqdm

psd2pngs-1.0.0/src/psd2pngs.egg-info/top_level.txt

@@ -0,0 +1 @@
+psd2pngs

psd2pngs-1.0.0/tests/test_convert.py

@@ -0,0 +1,10 @@
+from unittest import TestCase
+
+from psd2pngs import convert
+
+
+class TestConvert(TestCase):
+    def test_convert(self):
+        convert(
+            r"tests/cc0-psds/1.psd", use_json_camel_case=True, out_dir_path="tests/.test_results"
+        )

psd2pngs-1.0.0/tests/test_multiprocessing.py

@@ -0,0 +1,17 @@
+import concurrent.futures
+from itertools import repeat
+from unittest import TestCase
+
+from tqdm import tqdm
+
+
+def multiprocessing_task(pbar):
+    for _i in range(200000):
+        pbar.update(1)  # No errors but does not work
+
+
+class MultiprocessingTest(TestCase):
+    def test_tqdm(self):
+        pbar = tqdm(range(1000000))
+        with concurrent.futures.ProcessPoolExecutor() as executor:
+            executor.map(multiprocessing_task, repeat(pbar), range(5))