# <img src="docs/_static/fileseq_large.png" width="30%" height="30%" title="Fileseq" alt="Fileseq">
[](http://fileseq.readthedocs.io/en/latest/) [](https://github.com/justinfx/fileseq/actions/workflows/ci.yml)
A Python library for parsing frame ranges and file sequences commonly
used in VFX and Animation applications.
## Frame Range Shorthand
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
* Subframes: 1001-1066x0.25, 1001.5-1066.0x0.5
* Padding: #=4 padded, @=1 padded
* Alternate padding: #=1 padded, @=1 padded
* Printf Syntax Padding: %04d=4 padded, %01d=1 padded
* Houdini Syntax Padding: $F4=4 padding, $F=1 padded
* Udim Syntax Padding: <UDIM> or %(UDIM)d, always 4 padded
## FrameSets
A FrameSet wraps a sequence of frames in a list container.
### Iterate a FrameSet
```python
fs = fileseq.FrameSet("1-5")
for f in fs:
print(f)
```
### Access Frames
#### Using Indices:
```python
>>> fs = fileseq.FrameSet("1-100:8")
>>> fs[0] # First frame.
1
>>> fs[-1] # Last frame.
98
```
#### Using Convenience Methods:
```python
>>> fs = fileseq.FrameSet("1-100:8")
>>> fs.start() # First frame.
1
>>> fs.end() # Last frame.
98
```
## FileSequence
### Instantiate from String
```python
fileseq.FileSequence("/foo/bar.1-10#.exr")
fileseq.FileSequence("/foo/bar.1-10x0.25#.#.exr", allow_subframes=True)
```
### Format Path for VFX Software
#### Using FileSequence.format Method:
```python
>>> 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", allow_subframes=True)
>>> seq.format(template='{dirname}{basename}{padding}{extension}')
"/foo/bar.#.#.exr"
```
#### Joining:
```python
>>> 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"
```
#### Alternate Padding Styles:
```python
>>> seq = fileseq.FileSequence("/foo/bar.1-10#.exr", pad_style=fileseq.PAD_STYLE_HASH1)
>>> list(seq)
['/foo/bar.1.exr',
'/foo/bar.2.exr',
'/foo/bar.3.exr',
'/foo/bar.4.exr',
'/foo/bar.5.exr',
'/foo/bar.6.exr',
'/foo/bar.7.exr',
'/foo/bar.8.exr',
'/foo/bar.9.exr',
'/foo/bar.10.exr']
>>> seq = fileseq.FileSequence("/foo/bar.1-10#.exr", pad_style=fileseq.PAD_STYLE_HASH4)
>>> list(seq)
['/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']
```
### Get List of File Paths
```python
>>> 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']
```
## Finding Sequences on Disk
### Check a Directory for All Existing Sequences
```python
seqs = fileseq.findSequencesOnDisk("/show/shot/renders/bty_foo/v1")
```
### Check a Directory for One Existing Sequence.
* 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:
```python
fileseq.findSequenceOnDisk('/foo/bar.@.exr')
```
Yes:
```python
fileseq.findSequenceOnDisk('/foo/bar.@@@@@.exr')
```
No:
```python
fileseq.findSequenceOnDisk('/foo/bar.*.exr')
```
* To find subframe sequences you must explicitly opt-in
```python
fileseq.findSequenceOnDisk('/foo/bar.#.#.exr', allow_subframes=True)
```
## Limitations
While there may be many custom types of sequence patterns that could be considered a valid pipeline format, this library has
taken an opinionated stance on acceptable sequence formats. This is done to keep parsing rules manageable and to not
over-complicate the logic. The parsing rules can and have been expanded in some ways over time, such as adding support
for new padding format patterns like printf "%04d", houdini "$F" and "<UDIM>". But other rules remain the same, such as expecting
a frame number component to be found just before the file extension component.
## Language Ports
* Go: https://github.com/justinfx/gofileseq
* C++: https://github.com/justinfx/gofileseq/tree/master/cpp
Raw data
{
"_id": null,
"home_page": "https://github.com/justinfx/fileseq",
"name": "Fileseq",
"maintainer": "Justin Israel",
"docs_url": "https://pythonhosted.org/Fileseq/",
"requires_python": null,
"maintainer_email": "justinisrael@gmail.com",
"keywords": "vfx visual effects file sequence frames image",
"author": "Matt Chambers",
"author_email": "yougotrooted@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/70/45/d61b3065f1b04e7f3fea9bf8e6508077baf79a737e38c02dc6accb0a3393/fileseq-2.1.1.tar.gz",
"platform": null,
"description": "# <img src=\"docs/_static/fileseq_large.png\" width=\"30%\" height=\"30%\" title=\"Fileseq\" alt=\"Fileseq\">\n\n[](http://fileseq.readthedocs.io/en/latest/) [](https://github.com/justinfx/fileseq/actions/workflows/ci.yml)\n\nA Python library for parsing frame ranges and file sequences commonly \nused in VFX and Animation applications.\n\n## Frame Range Shorthand\n\nSupport for:\n\n* Standard: 1-10\n* Comma Delimited: 1-10,10-20\n* Chunked: 1-100x5\n* Filled: 1-100y5\n* Staggered: 1-100:3 (1-100x3, 1-100x2, 1-100)\n* Negative frame numbers: -10-100\n* Subframes: 1001-1066x0.25, 1001.5-1066.0x0.5\n* Padding: #=4 padded, @=1 padded\n* Alternate padding: #=1 padded, @=1 padded\n* Printf Syntax Padding: %04d=4 padded, %01d=1 padded\n* Houdini Syntax Padding: $F4=4 padding, $F=1 padded\n* Udim Syntax Padding: <UDIM> or %(UDIM)d, always 4 padded\n\n\n## FrameSets\n\nA FrameSet wraps a sequence of frames in a list container.\n\n### Iterate a FrameSet\n```python\nfs = fileseq.FrameSet(\"1-5\")\nfor f in fs:\n print(f)\n```\n\n### Access Frames\n\n#### Using Indices:\n```python\n>>> fs = fileseq.FrameSet(\"1-100:8\")\n>>> fs[0] # First frame.\n1\n>>> fs[-1] # Last frame.\n98\n```\n\n#### Using Convenience Methods:\n```python\n>>> fs = fileseq.FrameSet(\"1-100:8\")\n>>> fs.start() # First frame.\n1\n>>> fs.end() # Last frame.\n98\n```\n\n## FileSequence\n\n### Instantiate from String\n```python\nfileseq.FileSequence(\"/foo/bar.1-10#.exr\")\nfileseq.FileSequence(\"/foo/bar.1-10x0.25#.#.exr\", allow_subframes=True)\n```\n\n### Format Path for VFX Software\n\n#### Using FileSequence.format Method:\n```python\n>>> seq = fileseq.FileSequence(\"/foo/bar.1-10#.exr\")\n>>> seq.format(template='{dirname}{basename}{padding}{extension}') \n\"/foo/bar.#.exr\"\n>>> seq = fileseq.FileSequence(\"/foo/bar.1-10#.#.exr\", allow_subframes=True)\n>>> seq.format(template='{dirname}{basename}{padding}{extension}')\n\"/foo/bar.#.#.exr\"\n```\n\n#### Joining:\n```python\n>>> seq = fileseq.FileSequence(\"/foo/bar.1-10#.exr\")\n>>> ''.join([seq.dirname(), seq.basename(), '%0{}d'.format(len(str(seq.end()))), seq.extension()])\n\"/foo/bar.%02d.exr\"\n```\n\n#### Alternate Padding Styles:\n```python\n>>> seq = fileseq.FileSequence(\"/foo/bar.1-10#.exr\", pad_style=fileseq.PAD_STYLE_HASH1)\n>>> list(seq)\n['/foo/bar.1.exr',\n '/foo/bar.2.exr',\n '/foo/bar.3.exr',\n '/foo/bar.4.exr',\n '/foo/bar.5.exr',\n '/foo/bar.6.exr',\n '/foo/bar.7.exr',\n '/foo/bar.8.exr',\n '/foo/bar.9.exr',\n '/foo/bar.10.exr']\n>>> seq = fileseq.FileSequence(\"/foo/bar.1-10#.exr\", pad_style=fileseq.PAD_STYLE_HASH4)\n>>> list(seq)\n['/foo/bar.0001.exr',\n '/foo/bar.0002.exr',\n '/foo/bar.0003.exr',\n '/foo/bar.0004.exr',\n '/foo/bar.0005.exr',\n '/foo/bar.0006.exr',\n '/foo/bar.0007.exr',\n '/foo/bar.0008.exr',\n '/foo/bar.0009.exr',\n '/foo/bar.0010.exr']\n```\n\n### Get List of File Paths\n```python\n>>> seq = fileseq.FileSequence(\"/foo/bar.1-10#.exr\")\n>>> [seq[idx] for idx, fr in enumerate(seq.frameSet())]\n['/foo/bar.0001.exr',\n '/foo/bar.0002.exr',\n '/foo/bar.0003.exr',\n '/foo/bar.0004.exr',\n '/foo/bar.0005.exr',\n '/foo/bar.0006.exr',\n '/foo/bar.0007.exr',\n '/foo/bar.0008.exr',\n '/foo/bar.0009.exr',\n '/foo/bar.0010.exr']\n```\n\n## Finding Sequences on Disk\n\n### Check a Directory for All Existing Sequences\n```python\nseqs = fileseq.findSequencesOnDisk(\"/show/shot/renders/bty_foo/v1\")\n```\n\n### Check a Directory for One Existing Sequence.\n* Use a '@' or '#' where you might expect to use '*' for a wildcard character. \n* For this method, it doesn't matter how many instances of the padding character you use, it will still find your sequence.\n\nYes:\n```python\nfileseq.findSequenceOnDisk('/foo/bar.@.exr')\n```\nYes:\n```python\nfileseq.findSequenceOnDisk('/foo/bar.@@@@@.exr')\n```\nNo: \n```python\nfileseq.findSequenceOnDisk('/foo/bar.*.exr')\n```\n\n* To find subframe sequences you must explicitly opt-in\n```python\nfileseq.findSequenceOnDisk('/foo/bar.#.#.exr', allow_subframes=True)\n```\n\n## Limitations\n\nWhile there may be many custom types of sequence patterns that could be considered a valid pipeline format, this library has \ntaken an opinionated stance on acceptable sequence formats. This is done to keep parsing rules manageable and to not \nover-complicate the logic. The parsing rules can and have been expanded in some ways over time, such as adding support\nfor new padding format patterns like printf \"%04d\", houdini \"$F\" and \"<UDIM>\". But other rules remain the same, such as expecting\na frame number component to be found just before the file extension component.\n\n## Language Ports\n\n* Go: https://github.com/justinfx/gofileseq\n* C++: https://github.com/justinfx/gofileseq/tree/master/cpp\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A Python library for parsing frame ranges and file sequences commonly used in VFX and Animation applications.",
"version": "2.1.1",
"project_urls": {
"Homepage": "https://github.com/justinfx/fileseq"
},
"split_keywords": [
"vfx",
"visual",
"effects",
"file",
"sequence",
"frames",
"image"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "cab03ce196fd3eebf23ecc1f429e896c6c296e0a916ec42c55086eaacd045d9b",
"md5": "d35a09a95bd2fc67df15e0337abcf9ad",
"sha256": "89ddc8c2ea458999a0ef844f7d708e32b4d74fcb0701418a5cd1e1902c15c551"
},
"downloads": -1,
"filename": "Fileseq-2.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d35a09a95bd2fc67df15e0337abcf9ad",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 35318,
"upload_time": "2024-04-20T00:50:39",
"upload_time_iso_8601": "2024-04-20T00:50:39.957784Z",
"url": "https://files.pythonhosted.org/packages/ca/b0/3ce196fd3eebf23ecc1f429e896c6c296e0a916ec42c55086eaacd045d9b/Fileseq-2.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7045d61b3065f1b04e7f3fea9bf8e6508077baf79a737e38c02dc6accb0a3393",
"md5": "53112ef13c7ea3b768def31f6086ae97",
"sha256": "bda13864bf7a602013eb1f485230eb1963c449a49f10572dbde7fd425ed17119"
},
"downloads": -1,
"filename": "fileseq-2.1.1.tar.gz",
"has_sig": false,
"md5_digest": "53112ef13c7ea3b768def31f6086ae97",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 58457,
"upload_time": "2024-04-20T00:50:41",
"upload_time_iso_8601": "2024-04-20T00:50:41.330972Z",
"url": "https://files.pythonhosted.org/packages/70/45/d61b3065f1b04e7f3fea9bf8e6508077baf79a737e38c02dc6accb0a3393/fileseq-2.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-20 00:50:41",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "justinfx",
"github_project": "fileseq",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "fileseq"
}
JSON
