renumSeq 2.0.0__py3-none-any.whl → 2.1.1__py3-none-any.whl

renumseq/__main__.py

@@ -2,7 +2,7 @@
 
 # 3-Clause BSD License
 # 
-# Copyright (c) 2008-2025, James Philip Rowell,
+# Copyright (c) 2008-2026, James Philip Rowell,
 # Alpha Eleven Incorporated
 # www.alpha-eleven.com
 # All rights reserved.
@@ -54,13 +54,21 @@ import glob
 # MINOR version for added functionality in a backwards compatible manner
 # PATCH version for backwards compatible bug fixes
 #
-VERSION = "2.0.0"
+VERSION = "2.1.1"
 
 PROG_NAME = "renumseq"
 
-EXIT_NO_ERROR         = 0 # Clean exit.
-EXIT_ERROR            = 1 # Internal error other than argparse - currently not used.
-EXIT_ARGPARSE_ERROR   = 2 # The default code that argparse exits with if bad option.
+EXIT_NO_ERROR                 =   0 # Clean exit.
+EXIT_PREEXISTINGSEQ_ERROR     =   1 # Attempting to rename seq to one that already exists.
+EXIT_ARGPARSE_ERROR           =   2 # Parsing an argument revealed an error.
+EXIT_NULLACTION_WARNING       =   4 # Exited with nothing to do.
+EXIT_INVALIDRANGE_WARNING     =   8 # Invalid frame-range specified for a sequence
+EXIT_NOTASEQ_WARNING          =  16 # Expecting a sequence, but doesn't appear to be one.
+EXIT_NONEXISTENTSEQ_WARNING   =  32 # Specified sequence does not exist.
+EXIT_OVERWRITEFRAME_WARNING   =  64 # Renumbering a sequence would
+#                                   # have over-written some frames outside the range specifed.
+#
+gExitStatus = EXIT_NO_ERROR
 
 # List of date formats accepted to set file times with --touch.
 # They are same as the formats used by 'lsseq --only-show'.
@@ -91,13 +99,17 @@ class Touch(Enum):
     SPECIFIC_TIME = 3
 
 def warnSeqSyntax(silent, basename, seq) :
+    global gExitStatus
     if not silent :
         print( PROG_NAME,
             ": warning: invalid range [", seq, "] for seq ", basename,
             file=sys.stderr, sep='')
+    gExitStatus = gExitStatus | EXIT_INVALIDRANGE_WARNING
 
 def main():
 
+    global gExitStatus
+
     NEVER_START_FRAME = -999999999999 # Seems safe enough.
     howToTouch = ""   # Set below.
     specificTime = 0  # Set below.
@@ -132,7 +144,7 @@ def main():
                 $ lsseq
                 aaa.[011-015].tif
             '''),
-        usage="%(prog)s [OPTION]... [SEQ]...")
+        usage="%(prog)s [-h | --help] [OPTION]... [SEQ]...")
 
     p.add_argument("--version", action="version", version=VERSION)
 
@@ -266,7 +278,7 @@ def main():
                 print(PROG_NAME, ": error: --rename will rename the sequence in-place, so please omit the path ",
                     '/'.join(args.newSeqName[0].split('/')[:-1]),
                     file=sys.stderr, sep='')
-            sys.exit(EXIT_ARGPARSE_ERROR)
+            sys.exit(gExitStatus | EXIT_ARGPARSE_ERROR)
 
         match = lsseqPattern.search(args.newSeqName[0])
 
@@ -276,7 +288,7 @@ def main():
                     file=sys.stderr, sep='')
                 print("                 omitted from '--rename ", args.newSeqName[0], "'", " by mistake?",
                     file=sys.stderr, sep='')
-            sys.exit(EXIT_ARGPARSE_ERROR)
+            sys.exit(gExitStatus | EXIT_ARGPARSE_ERROR)
 
         elif len(args.files) >= 1 and match : # If len() > 1 then also invalid, but this catches both.
             if not args.silent :
@@ -286,13 +298,13 @@ def main():
                     file=sys.stderr, sep='')
                 print("                 appears to be a full lsseq native-format description of a sequence.",
                     file=sys.stderr, sep='')
-            sys.exit(EXIT_ARGPARSE_ERROR)
+            sys.exit(gExitStatus | EXIT_ARGPARSE_ERROR)
 
         elif len(args.files) > 1 :
             if not args.silent :
                 print(PROG_NAME, ": error: can NOT rename more than one SEQ at a time.",
                     file=sys.stderr, sep='')
-            sys.exit(EXIT_ARGPARSE_ERROR)
+            sys.exit(gExitStatus | EXIT_ARGPARSE_ERROR)
 
         # Now check to see if a sequence with NEW_SEQNAME exists already.
         # This code relies on lsseq >= v2.5.0 be installed.
@@ -320,10 +332,10 @@ def main():
                         print(PROG_NAME, ": error: can NOT rename to an existing sequence ",
                             lsseqResult.stdout,
                             file=sys.stderr, sep='', end='')
-                    sys.exit(EXIT_ARGPARSE_ERROR)
+                    sys.exit(gExitStatus | EXIT_PREEXISTINGSEQ_ERROR)
 
     if len(args.files) == 0 :
-        sys.exit(EXIT_NO_ERROR)
+        sys.exit(gExitStatus)
 
     # The following logic means "do nothing" - so just exit cleanly (**b**)
     #
@@ -336,7 +348,7 @@ def main():
             print(PROG_NAME,
                 ": warning: no offset, no rename, no padding change, etc., nothing to do",
                 file=sys.stderr, sep='')
-        sys.exit(EXIT_NO_ERROR)
+        sys.exit(gExitStatus | EXIT_NULLACTION_WARNING)
 
     # args.touch is either a string, presumably containing a date (so need to
     # check its validity), the string "0" (meaning --touch was called with NO argument),
@@ -386,7 +398,7 @@ def main():
                 print(PROG_NAME,
                     ": error: argument --touch: the time must be of the form [CC]YYMMDD[-hh[mm[ss]]]",
                     file=sys.stderr, sep='')
-            sys.exit(EXIT_ARGPARSE_ERROR)
+            sys.exit(gExitStatus | EXIT_ARGPARSE_ERROR)
 
         specificTime = int(time.mktime(timeData.timetuple())) # Epoch time
 
@@ -404,6 +416,7 @@ def main():
                 print(PROG_NAME, ": warning: ", arg,
                     " not a sequence or not in lsseq native format",
                     file=sys.stderr, sep='')
+            gExitStatus = gExitStatus | EXIT_NOTASEQ_WARNING
             continue
 
         v = match.groups()
@@ -494,6 +507,7 @@ def main():
                     print(PROG_NAME,
                         ": warning: no offset, no padding/underscore change, skipping sequence: ",
                         arg, file=sys.stderr, sep='')
+                # No change to exit codes since other seq's might have been changed.
                 continue
 
         startPad = len(startStr)
@@ -582,6 +596,7 @@ def main():
             if not args.silent :
                 print(PROG_NAME, ": warning: ", arg,
                     " is nonexistent", file=sys.stderr, sep='')
+            gExitStatus = gExitStatus | EXIT_NONEXISTENTSEQ_WARNING
             continue
 
         if not args.clobber :
@@ -599,6 +614,7 @@ def main():
                         ": renumbering would have overwritten a file outside the sequence being renumbered. e.g.: ",
                         f, file=sys.stderr, sep='')
                 continue
+                gExitStatus = gExitStatus | EXIT_OVERWRITEFRAME_WARNING
 
         i = 0
         numFiles = len(origName)
@@ -630,6 +646,7 @@ def main():
             print(PROG_NAME,
                 ": warning: no changes were made to ", arg, ": skipping",
                 file=sys.stderr, sep='')
+        # gExitStatus not changed as other sequences specified may have been changed.
 
 if __name__ == '__main__':
     main()

renumseq-2.1.1.dist-info/METADATA

@@ -0,0 +1,238 @@
+Metadata-Version: 2.4
+Name: renumSeq
+Version: 2.1.1
+Summary: Tool to renumber image sequences.
+Home-page: https://github.com/jrowellfx/renumSeq
+Author: James Philip Rowell
+Author-email: james@alpha-eleven.com
+License: BSD-3-Clause
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: POSIX
+Classifier: Operating System :: Unix
+Classifier: Operating System :: MacOS
+Classifier: Development Status :: 5 - Production/Stable
+Requires-Python: >=3.7, <4
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: seqLister>=1.2.0
+Requires-Dist: lsseq>=4.0.0
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# About renumseq
+
+`renumseq` is a Unix/Linux command-line-utility for renumbering image-sequences
+which are most
+typically used in VFX post-production or CG animation production.
+
+`renumseq` allows you to renumber sequences with an offset or give them a new `start` frame.
+It also allows you adjust the padding of the frame numbers.
+
+`renumseq` uses the syntax of the native output of
+[`lsseq`](https://github.com/jrowellfx/lsseq) to specify
+the sequence to be renumbered. Therefore it is recommended to
+use `lsseq` as it makes using `renumseq` easier.
+
+For example, use `lsseq` to list a sequence, then
+cut and paste its
+output as the arguments to `renumseq` with the appropriate 
+arguments for setting the offset or new start-frame.
+
+`renumseq` was written to be safe in that it won't
+unintentionally overwrite any existing files
+during renumbering.
+
+If `renumseq` finds that by renumbering a sequence it will write over another frame
+outside the range specified then it will skip renumbering that sequence
+(printing a warning) and go onto the next sequence in the list.  Naturally
+there is an option to force `renumseq` to overwrite those files if desired.
+
+`renumseq` doesn't need to make temporary copies of files during the renumbering
+(it does a move of the file), so it's fast.
+
+`renumseq` also has a useful option, called `--replace-underscore`
+that changes any underscore-separators (separating the filename from the
+frame-number) with dot-separators, like this:  
+
+`filename_[n-m].extension` -> `filename.[n-m].extension`
+
+`Protip`: If all you want to do is switch the separator from an underscore to a dot, then
+use a zero offset, plus the `--replace-underscore` argument.
+
+## Error and warning codes returned from `renumseq`
+
+As copied from the source code,
+the following EXIT codes will be combined bitwise to return
+possibly more than one different warning and/or error.
+
+```
+EXIT_NO_ERROR                 =   0 # Clean exit.
+EXIT_PREEXISTINGSEQ_ERROR     =   1 # Attempting to rename seq to one that already exists.
+EXIT_ARGPARSE_ERROR           =   2 # Parsing an argument revealed an error.
+EXIT_NULLACTION_WARNING       =   4 # Exited with nothing to do.
+EXIT_INVALIDRANGE_WARNING     =   8 # Invalid frame-range specified for a sequence
+EXIT_NOTASEQ_WARNING          =  16 # Expecting a sequence, but doesn't appear to be one.
+EXIT_NONEXISTENTSEQ_WARNING   =  32 # Specified sequence does not exist.
+EXIT_OVERWRITEFRAME_WARNING   =  64 # Renumbering a sequence would
+                                    # have over-written some frames outside the range specifed.
+```
+
+## Installing renumseq
+
+```
+python3 -m pip install renumSeq --upgrade
+```
+
+## Testing renumseq
+
+After installing try the following:
+
+```
+$ cd ~
+$ mkdir tmp
+$ cd tmp
+$ touch aaa.001.tif aaa.002.tif aaa.003.tif aaa.004.tif aaa.005.tif
+$ lsseq -Z
+aaa.[001-005].tif
+$ renumseq --verbose --offset 10 'aaa.[001-005].tif'
+aaa.005.tif -> aaa.015.tif
+aaa.004.tif -> aaa.014.tif
+aaa.003.tif -> aaa.013.tif
+aaa.002.tif -> aaa.012.tif
+aaa.001.tif -> aaa.011.tif
+$ lsseq -Z
+aaa.[011-015].tif
+```
+
+Note that you may get an error from your
+shell when you try to run the `renumseq` command above, without the
+quotes around the sequence, that might look something like
+this:
+
+```
+% renumseq -o 10 aaa.[001-005].tif
+renumseq: No match.
+```
+
+In which case you need to "escape" the square brackets as they are special characters
+as far as the shell is concerned. Escape them like this:
+
+```
+% renumseq -v -o 10 aaa.\[001-005\].tif
+aaa.005.tif -> aaa.015.tif
+aaa.004.tif -> aaa.014.tif
+aaa.003.tif -> aaa.013.tif
+aaa.002.tif -> aaa.012.tif
+aaa.001.tif -> aaa.011.tif
+```
+
+Alternatively you can just enclose the argument in quotes
+(`'aaa.[001-005].tif'`)
+like we did in the example above.
+
+Type this:
+
+```
+$ renumseq --help
+```
+...for much more useful info.
+
+# Important: latest MAJOR point release of `renumSeq`.
+
+`renumseq` and all the utilities provided by jrowellfx github repos
+use "[`Semantic Versioning 2.0.0`](https://semver.org/)" in numbering releases.
+The latest release of `renumseq` upped the `MAJOR` release number
+from `v1.x.x` to `v2.x.x`.
+
+While the functionality and output of `renumseq` has not changed, all the so called
+"long options" have been renamed to adhere to `POSIX` standard naming
+conventions.
+
+That is, prior to `v2.0.0` of `renumseq` all the long-option names used a "camel case"
+naming convention but as of `v2.0.0` all long-option names have been
+changed to so-called "kebab case".
+
+For example:
+
+```
+--replaceUnderscore
+```
+
+has been changed to
+
+```
+--replace-underscore
+```
+
+In the event that you have written any scripts that make use of `renumseq` or
+any other of `jrowellfx`'s utils provided [here](https://github.com/jrowellfx) 
+you will need to edit your scripts to be able to update to the lastest versions
+of the utilities.
+
+In this case, in order to assist in switching to the
+current `MAJOR` point release some `sed` scripts have been provided that should make
+the transition quite painless. Especially if you make use
+of [`runsed`](https://github.com/jrowellfx/vfxTdUtils) which if you haven't used it before,
+now is the time, it's extremely helpful.
+
+There are two files provided at the root-level of the repo, namely:
+`sed.script.jrowellfx.doubleDashToKebab` and `sed.script.renumseq.v1tov2`.
+
+The first one can be used to fix the long-option names for ALL the 
+`MAJOR` point release updates to the long-options in any of `jrowellfx`'s utilities.
+The second one contains only changes needed for the updates to `renumseq`.
+
+## Example `sed.script` usage.
+
+Download one or both of the sed scripts named above. Make sure you have `runsed` installed
+on your system. (Example applied to usage of `lsseq` but it's the same idea for `renumseq`.)
+
+```
+$ cd ~/bin
+$ ls
+myScriptThatUsesLsseq
+$ cat myScriptThatUsesLsseq
+#!/bin/bash
+
+lsseq --globalSortByTime --recursive --prependPathAbs /Volumes/myProjectFiles
+
+$ mv ~/Downloads/sed.script.jrowellfx.doubleDashToKebab sed.script
+$ runsed myScriptThatUsesLsseq
+$ ./.runsed.diff.runsed
++ /usr/bin/diff ./.myScriptThatUsesLsseq.runsed myScriptThatUsesLsseq
+3c3
+< lsseq --globalSortByTime --recursive --prependPathAbs /Volumes/myProjectFiles
+---
+> lsseq --global-sort-by-time --recursive --prepend-path-abs /Volumes/myProjectFiles
+$ cat myScriptThatUsesLsseq
+#!/bin/bash
+
+lsseq --global-sort-by-time --recursive --prepend-path-abs /Volumes/myProjectFiles
+```
+
+Note that if you are unhappy with the changes you can undo them easily with
+
+```
+$ ./.runsed.undo.runsed
+$ cat myScriptThatUsesLsseq
+#!/bin/bash
+
+lsseq --globalSortByTime --recursive --prependPathAbs /Volumes/myProjectFiles
+
+
+```
+
+## Contact
+
+Please contact `j a m e s <at> a l p h a - e l e v e n . c o m` with any bug
+reports, suggestions or praise as the case may be.
+

renumseq-2.1.1.dist-info/RECORD

@@ -0,0 +1,8 @@
+renumseq/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+renumseq/__main__.py,sha256=Qjz__E4hejj8p3a2JMTOWBe30ie7RiDDlw2muqmheLk,26982
+renumseq-2.1.1.dist-info/licenses/LICENSE,sha256=6nkMza9EsLm_5eVujz579iCb9pLToaliSRuycs41Z28,1620
+renumseq-2.1.1.dist-info/METADATA,sha256=6bKv8_eYFOgnftML95BwcSqaACHOjwlarsDmx5x97zg,7616
+renumseq-2.1.1.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
+renumseq-2.1.1.dist-info/entry_points.txt,sha256=Vu6IBWCxwfVRG3XOZi4ENlMnpe4igvepbHfKy8NGuOY,52
+renumseq-2.1.1.dist-info/top_level.txt,sha256=N4wzD8IZmW7curkqRcVgXNstK4X3cqZ4K1tVNYsukDI,9
+renumseq-2.1.1.dist-info/RECORD,,

{renumSeq-2.0.0.dist-info → renumseq-2.1.1.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (75.8.0)
+Generator: setuptools (80.10.2)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

{renumSeq-2.0.0.dist-info → renumseq-2.1.1.dist-info/licenses}/LICENSE

@@ -1,6 +1,6 @@
 3-Clause BSD License
 
-Copyright (c) 2008-2025, James Philip Rowell,
+Copyright (c) 2008-2026, James Philip Rowell,
 Alpha Eleven Incorporated
 www.alpha-eleven.com
 All rights reserved.

renumSeq-2.0.0.dist-info/METADATA

@@ -1,127 +0,0 @@
-Metadata-Version: 2.2
-Name: renumSeq
-Version: 2.0.0
-Summary: Tool to renumber image sequences.
-Home-page: https://github.com/jrowellfx/renumSeq
-Author: James Philip Rowell
-Author-email: james@alpha-eleven.com
-Classifier: Programming Language :: Python :: 3
-Classifier: License :: OSI Approved :: BSD License
-Classifier: Operating System :: POSIX
-Classifier: Operating System :: Unix
-Classifier: Operating System :: MacOS
-Classifier: Development Status :: 5 - Production/Stable
-Requires-Python: >=3.7, <4
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: seqLister>=1.2.0
-Requires-Dist: lsseq>=4.0.0
-Dynamic: author
-Dynamic: author-email
-Dynamic: classifier
-Dynamic: description
-Dynamic: description-content-type
-Dynamic: home-page
-Dynamic: requires-dist
-Dynamic: requires-python
-Dynamic: summary
-
-# About renumseq
-
-`renumseq` is a Unix/Linux command-line-utility for renumbering image-sequences
-which are most
-typically used in CG post-production.
-
-`renumseq` allows you to renumber sequences with an offset or give them a new `start` frame.
-It also allows you adjust the padding of the frame numbers.
-
-`renumseq` uses the syntax of the native output of
-[`lsseq`](https://github.com/jrowellfx/lsseq) to specify
-the sequence to be renumbered. Therefore it is recommended to
-use `lsseq` as it makes using `renumseq` easier.
-
-For example, use `lsseq` to list a sequence, then
-cut and paste its
-output as the arguments to `renumseq` with the appropriate 
-arguments for setting the offset or new start-frame.
-
-`renumseq` was written to be safe in that it won't
-unintentionally overwrite any existing files
-during renumbering.
-
-If `renumseq` finds that by renumbering a sequence it will write over another frame
-outside the range specified then it will skip renumbering that sequence
-(printing a warning) and go onto the next sequence in the list.  Naturally
-there is an option to force `renumseq` to overwrite those files if desired.
-
-`renumseq` doesn't need to make temporary copies of files during the renumbering
-(it does a move of the file), so it's fast.
-
-`renumseq` also has a useful option, called `--replace-underscore`
-that changes any underscore-separators (separating the filename from the
-frame-number) with dot-separators, like this:  
-
-`filename_[n-m].extension` -> `filename.[n-m].extension`
-
-`Protip`: If all you want to do is switch the separator from an underscore to a dot, then
-use a zero offset, plus the `--replace-underscore` argument.
-
-## Installing renumseq
-
-```
-python3 -m pip install renumSeq --upgrade
-```
-
-## Testing renumseq
-
-After installing try the following:
-
-```
-$ cd ~
-$ mkdir tmp
-$ cd tmp
-$ touch aaa.001.tif aaa.002.tif aaa.003.tif aaa.004.tif aaa.005.tif
-$ lsseq -Z
-aaa.[001-005].tif
-$ renumseq --verbose --offset 10 'aaa.[001-005].tif'
-aaa.005.tif -> aaa.015.tif
-aaa.004.tif -> aaa.014.tif
-aaa.003.tif -> aaa.013.tif
-aaa.002.tif -> aaa.012.tif
-aaa.001.tif -> aaa.011.tif
-$ lsseq -Z
-aaa.[011-015].tif
-```
-
-Note that you may get an error from your
-shell when you try to run the `renumseq` command above, without the
-quotes around the sequence, that might look something like
-this:
-
-```
-% renumseq -o 10 aaa.[001-005].tif
-renumseq: No match.
-```
-
-In which case you need to "escape" the square brackets as they are special characters
-as far as the shell is concerned. Escape them like this:
-
-```
-% renumseq -v -o 10 aaa.\[001-005\].tif
-aaa.005.tif -> aaa.015.tif
-aaa.004.tif -> aaa.014.tif
-aaa.003.tif -> aaa.013.tif
-aaa.002.tif -> aaa.012.tif
-aaa.001.tif -> aaa.011.tif
-```
-
-Alternatively you can just enclose the argument in quotes
-(`'aaa.[001-005].tif'`)
-like we did in the example above.
-
-Type this:
-
-```
-$ renumseq --help
-```
-...for much more useful info.

renumSeq-2.0.0.dist-info/RECORD

@@ -1,8 +0,0 @@
-renumseq/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-renumseq/__main__.py,sha256=Th2VHRQFAtORHtdksQAFZjhtKujhEJSbs9GqrMpO4AI,25867
-renumSeq-2.0.0.dist-info/LICENSE,sha256=7ssn-dBSkdFTvXKCXb6weBMit69-58B_3P7GA5VBvms,1620
-renumSeq-2.0.0.dist-info/METADATA,sha256=SanOxNCWBOpCAUVoTmNVt2M_CLlRvxZ-IU0nw5lKFvc,3718
-renumSeq-2.0.0.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
-renumSeq-2.0.0.dist-info/entry_points.txt,sha256=Vu6IBWCxwfVRG3XOZi4ENlMnpe4igvepbHfKy8NGuOY,52
-renumSeq-2.0.0.dist-info/top_level.txt,sha256=N4wzD8IZmW7curkqRcVgXNstK4X3cqZ4K1tVNYsukDI,9
-renumSeq-2.0.0.dist-info/RECORD,,