PYTHON.md

Python Notes

Sublime Text 4 uses python 3.8 and Sublime Text 3 uses Python 3.3
Link https://www.sublimetext.com/docs/porting_guide.html#python-3-3

Build package uses python 3.13.1.

Plugin follow ST python versions.

Package
├── src
|   ├── build # generate icons PNGs and icons data file
|   ├── data
|   ├── icons
│   └── zukan_icon_theme # plugin install files
├── tests
├── .coveragerc
├── .python.version
├── main.py
├── pyproject.toml
├── pytest.ini
├── ruff.toml
└── unittesting.json

Install

Build

# Use specific python version
$ poetry env use path-to-python/3.13.1/bin/python
$ poetry env use /Users/xxxxx/.pyenv/versions/3.13.1/bin/python
$ poetry env info
Virtualenv
Python:         3.13.1
Implementation: CPython

# Check if .python-version file has correct version. Important for 'poetry install'.
# It could be 3.3 or 3.8 because Sublime Text interpreter.
$ cat .python-version
3.13.1

# install
$ poetry install

Poetry notes

• If package do not install using poetry add <package> or during poetry install, use pip install <package>

Tests

Build tests

# Environment activated
$ pytest

Or

$ poetry run pytest

To disable coverage (pytest-cov)

# pytest.ini
# Comment line below to disable coverage
;addopts = --cov=src

# Pass other arguments
# See https://docs.pytest.org/en/8.0.x/reference/customize.html
addopts = -ra -q

test_scripts icon-theme command delay tests. If need, comment it in tests/mocks/constants_scripts.py.

Plugin tests

Using ST package UnitTesting.

Go to Tools > Command Palette... select UnitTesting: Test Package type Zukan Icon Theme.

Tests files are not bundled with releases. Need to clone repo.

.python-version needs to be 3.8. There is no subTest in 3.3.

# .coveragerc
; Comment [paths] to coverage plugin
; [paths]
; source = src

Build

Scripts used to generate icons files: PNGs and icon data file.

See build.md.

Plugin

Install icons tmPreferences, sublime-theme and sublime-syntax files.

See plugin.md.