From 77452501313476404fd616ad66ae5e06cf557c7a Mon Sep 17 00:00:00 2001 From: Justin Israel Date: Sun, 14 Apr 2024 16:46:17 +1200 Subject: [PATCH] Add note to FileSequence.__str__ about format caveat (fixes #133) --- docs/index.rst | 2 +- src/fileseq/__version__.py | 2 +- src/fileseq/filesequence.py | 7 +++++++ 3 files changed, 9 insertions(+), 2 deletions(-) diff --git a/docs/index.rst b/docs/index.rst index ed476c5..3274ba0 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -23,7 +23,7 @@ fileseq.filesequence module :members: :undoc-members: :show-inheritance: - :special-members: __getitem__, __iter__, __len__ + :special-members: __str__, __getitem__, __iter__, __len__, __setstate__ fileseq.frameset module ----------------------- diff --git a/src/fileseq/__version__.py b/src/fileseq/__version__.py index afced14..55fa725 100644 --- a/src/fileseq/__version__.py +++ b/src/fileseq/__version__.py @@ -1 +1 @@ -__version__ = '2.0.0' +__version__ = '2.1.1' diff --git a/src/fileseq/filesequence.py b/src/fileseq/filesequence.py index 48855bc..e905c42 100644 --- a/src/fileseq/filesequence.py +++ b/src/fileseq/filesequence.py @@ -759,6 +759,13 @@ def __str__(self): """ String representation of this :class:`FileSequence`. + Note: + A FileSequence that does not define a frame range will omit + the padding character component when string formatted, even + if the padding character is set. + For more control over the exact string format, use the + :obj:`FileSequence.format()` method. + Returns: str: """