PySeq
PySeq is a python module that finds groups of items that follow a naming convention containing
a numerical sequence index (e.g. fileA.001.png, fileA.002.png, fileA.003.png...) and serializes
them into a compressed sequence string representing the entire sequence (e.g. fileA.1-3.png). It
should work regardless of where the numerical sequence index is embedded in the name. For examples,
see basic usage below or http://rsgalloway.github.io/pyseq
Installation
The easiest way to install pyseq:
$ pip install pyseq
Basic Usage
Using the "z1" file sequence example in the "tests" directory, we start by listing the directory
contents using ls
:
$ ls tests/files/z1*
tests/files/z1_001_v1.1.png tests/files/z1_001_v1.4.png tests/files/z1_002_v1.3.png tests/files/z1_002_v2.11.png
tests/files/z1_001_v1.2.png tests/files/z1_002_v1.1.png tests/files/z1_002_v1.4.png tests/files/z1_002_v2.12.png
tests/files/z1_001_v1.3.png tests/files/z1_002_v1.2.png tests/files/z1_002_v2.10.png tests/files/z1_002_v2.9.png
Now we list the same directory contents using lss
, which will find the sequences and display them
in the default compressed format:
$ lss tests/files/z1*
4 z1_001_v1.%d.png [1-4]
4 z1_002_v1.%d.png [1-4]
4 z1_002_v2.%d.png [9-12]
With a custom format:
$ lss tests/files/z1* -f "%h%r%t"
z1_001_v1.1-4.png
z1_002_v1.1-4.png
z1_002_v2.9-12.png
Recursive:
$ lss -r tests
tests
βββ test_pyseq.py
βββ files
βββ 012_vb_110_v001.1-10.png
βββ 012_vb_110_v002.1-10.png
βββ a.1-14.tga
βββ alpha.txt
βββ bnc01_TinkSO_tx_0_ty_0.101-105.tif
βββ bnc01_TinkSO_tx_0_ty_1.101-105.tif
βββ bnc01_TinkSO_tx_1_ty_0.101-105.tif
βββ bnc01_TinkSO_tx_1_ty_1.101-105.tif
βββ file.1-2.tif
βββ file.info.03.rgb
βββ file01.1-4.j2k
βββ file01_40-43.rgb
βββ file02_44-47.rgb
βββ file1-4.03.rgb
βββ fileA.1-3.jpg
βββ fileA.1-3.png
βββ file_02.tif
βββ z1_001_v1.1-4.png
βββ z1_002_v1.1-4.png
βββ z1_002_v2.9-12.png
API Examples
Compression, or serialization, of lists of items:
>>> s = Sequence(['file.0001.jpg', 'file.0002.jpg', 'file.0003.jpg'])
>>> print(s)
file.1-3.jpg
>>> s.append('file.0006.jpg')
>>> print(s.format("%h%p%t %R"))
file.%04d.jpg [1-3, 6]
Uncompression, or deserialization, of compressed sequences strings:
>>> s = uncompress('./tests/012_vb_110_v001.%04d.png 1-1001', fmt='%h%p%t %r')
>>> len(s)
1001
>>> print(s.format('%04l %h%p%t %R'))
1001 012_vb_110_v001.%04d.png [1-1001]
Testing
To run the unit tests, simply run pytest
in a shell:
$ pytest
Or if you don't have pytest
, you can run:
$ python tests/test_pyseq.py