A Python library for parsing frame ranges and file sequences based on a similar library found in Katana.

Support for:

• Standard: 1-10
• Comma Delimited: 1-10,10-20
• Chunked: 1-100x5
• Filled: 1-100y5
• Staggered: 1-100:3 (1-100x3, 1-100x2, 1-100)
• Negative frame numbers: -10-100
• Padding: #=4 padded, @=single pad

A FrameSet wraps a sequence of frames in a list list container.

fs = fileseq.FrameSet("1-5")
for f in fs:
  print f

>>> fs = fileseq.FrameSet("1-100:8")
>>> fs[0] # First frame.
1
>>> fs[-1] # Last frame.
98

>>> fs = fileseq.FrameSet("1-100:8")
>>> fs.start() # First frame.
1
>>> fs.end() # Last frame.
98

fileseq.FileSequence("/foo/bar.1-10#.exr")

>>> seq = fileseq.FileSequence("/foo/bar.1-10#.exr")
>>> seq.format(template='{dirname}{basename}{padding}{extension}') 
"/foo/bar.#.exr"

>>> seq = fileseq.FileSequence("/foo/bar.1-10#.exr")
>>> ''.join([seq.dirname(), seq.basename(), '%0{}d'.format(len(str(seq.end()))), seq.extension()])
"/foo/bar.%02d.exr"

>>> seq = fileseq.FileSequence("/foo/bar.1-10#.exr")
>>> [seq[idx] for idx, fr in enumerate(seq.frameSet())]
['/foo/bar.0001.exr',
 '/foo/bar.0002.exr',
 '/foo/bar.0003.exr',
 '/foo/bar.0004.exr',
 '/foo/bar.0005.exr',
 '/foo/bar.0006.exr',
 '/foo/bar.0007.exr',
 '/foo/bar.0008.exr',
 '/foo/bar.0009.exr',
 '/foo/bar.0010.exr']

seqs = fileseq.findSequencesOnDisk("/show/shot/renders/bty_foo/v1")

• Use a '@' or '#' where you might expect to use '*' for a wildcard character.
• For this method, it doesn't matter how many instances of the padding character you use, it will still find your sequence.

Yes:

fileseq.findSequenceOnDisk('/foo/[email protected]')

Yes:

fileseq.findSequenceOnDisk('/foo/bar.@@@@@.exr')

No:

fileseq.findSequenceOnDisk('/foo/bar.*.exr')

From version 1.0.0, a FrameSet allows all the normal Set operations. It is now an immutable and hashable object in its own right, as well. This means that the order and contents are immutable values internally (a tuple and a frozenset, respectively), and that the FrameSet itself can be used as a key in a dictionary.

This also means that the null FrameSet (FrameSet('')) is a valid object, and something you should expect to receive back from any Set operations that would result in an empty return value. This brings the caveat that the FrameSet.start and FrameSet.end methods on a null FrameSet will raise an IndexError if called.

To help avoid confusion, a FrameSet.is_null attribute has been added in 1.0.1, which you can check before calling those methods.