#! /usr/bin/env python
"""
filesequence - A parsing object representing sequential files for fileseq.
"""
from __future__ import absolute_import
from builtins import next
from builtins import filter
from builtins import str
from builtins import map
from builtins import object
import future.utils as futils
from future.utils import iteritems
import os
import re
import functools
from glob import iglob
from fileseq.exceptions import ParseException, FileSeqException
from fileseq.constants import PAD_MAP, DISK_RE, SPLIT_RE, PRINTF_SYNTAX_PADDING_RE
from fileseq.frameset import FrameSet
from fileseq import utils
[docs]class FileSequence(object):
""":class:`FileSequence` represents an ordered sequence of files.
Args:
sequence (str): (ie: dir/path.1-100#.ext)
Returns:
:class:`FileSequence`:
Raises:
:class:`fileseq.exceptions.MaxSizeException`: If frame size exceeds
:const:`fileseq.constants.MAX_FRAME_SIZE`
"""
def __init__(self, sequence):
"""Init the class
"""
sequence = utils.asString(sequence)
if not hasattr(self, '_frameSet'):
self._frameSet = None
try:
# the main case, padding characters in the path.1-100#.exr
path, frames, self._pad, self._ext = SPLIT_RE.split(sequence, 1)
self._dir, self._base = os.path.split(path)
self._frameSet = FrameSet(frames)
except ValueError:
# edge case 1; we've got an invalid pad
for placeholder in PAD_MAP:
if placeholder in sequence:
msg = "Failed to parse FileSequence: {0}"
raise ParseException(msg.format(sequence))
# edge case 2; we've got a single frame of a sequence
a_frame = DISK_RE.match(sequence)
if a_frame:
self._dir, self._base, frames, self._ext = a_frame.groups()
# edge case 3: we've got a single versioned file, not a sequence
if frames and not self._base.endswith('.'):
self._base = self._base + frames
self._pad = ''
elif not frames:
self._pad = ''
self._frameSet = None
else:
self._frameSet = FrameSet(frames)
if self._frameSet:
self._pad = FileSequence.getPaddingChars(len(frames))
else:
self._pad = ''
self._frameSet = None
# edge case 4; we've got a solitary file, not a sequence
else:
path, self._ext = os.path.splitext(sequence)
self._dir, self._base = os.path.split(path)
self._pad = ''
if self._dir:
self.setDirname(self._dir)
self._zfill = self.__class__.getPaddingNum(self._pad)
[docs] def copy(self):
"""
Create a deep copy of this sequence
Returns:
:obj:`.FileSequence`:
"""
fs = self.__class__.__new__(self.__class__)
fs.__dict__ = self.__dict__.copy()
fs._frameSet = None
if self._frameSet is not None:
fs._frameSet = self._frameSet.copy()
return fs
[docs] def split(self):
"""
Split the :class:`FileSequence` into contiguous pieces and return them
as a list of :class:`FileSequence` instances.
Returns:
list[:class:`FileSequence`]:
"""
result = []
for frange in self.frameRange().split(","):
result.append(FileSequence(''.join(
(self._dir, self._base, frange, self._pad, self._ext))))
return result
[docs] def dirname(self):
"""
Return the directory name of the sequence.
Returns:
str:
"""
return self._dir
[docs] def setDirname(self, dirname):
"""
Set a new directory name for the sequence.
Args:
dirname (str): the new directory name
"""
# Make sure the dirname always ends in
# a path separator character
dirname = utils.asString(dirname)
sep = utils._getPathSep(dirname)
if not dirname.endswith(sep):
dirname = futils.native_str(dirname) + sep
self._dir = dirname
[docs] def basename(self):
"""
Return the basename of the sequence.
Returns:
str: sequence basename
"""
return self._base
[docs] def setBasename(self, base):
"""
Set a new basename for the sequence.
Args:
base (str): the new base name
"""
self._base = utils.asString(base)
[docs] def padding(self):
"""
Return the the padding characters in the sequence.
Returns:
str: sequence padding
"""
return self._pad
[docs] def setPadding(self, padding):
"""
Set new padding characters for the sequence.
i.e. "#" or "@@@" or '%04d', or an empty string to disable range formatting.
Args:
padding (str): sequence padding to set
"""
self._pad = padding
self._zfill = self.__class__.getPaddingNum(self._pad)
[docs] def frameSet(self):
"""
Return the :class:`.FrameSet` of the sequence if specified,
otherwise None.
Returns:
:class:`.FrameSet` or None:
"""
return self._frameSet
[docs] def setFrameSet(self, frameSet):
"""
Set a new :class:`.FrameSet` for the sequence.
Args:
frameSet (:class:`.FrameSet`): the new :class:`.FrameSet` object
"""
self._frameSet = frameSet
[docs] def extension(self):
"""
Return the file extension of the sequence, including leading period.
Returns:
str:
"""
return self._ext
[docs] def setExtension(self, ext):
"""
Set a new file extension for the sequence.
Note:
A leading period will be added if none is provided.
Args:
ext (str): the new file extension
"""
if ext[0] != ".":
ext = "." + ext
self._ext = utils.asString(ext)
[docs] def setExtention(self, ext):
"""
Deprecated: use :meth:`setExtension`.
Args:
ext (str):
"""
import warnings
msg = "the setExtention method is deprecated, please use setExtension"
warnings.warn(msg)
self.setExtension(ext)
[docs] def frameRange(self):
"""
Returns the string formatted frame range of the sequence.
Will return an empty string if the sequence has no frame pattern.
Returns:
str:
"""
if not self._frameSet:
return ''
return self._frameSet.frameRange(self._zfill)
[docs] def setFrameRange(self, frange):
"""
Set a new frame range for the sequence.
Args:
frange (str): a properly formatted frame range, as per :class:`.FrameSet`
"""
self._frameSet = FrameSet(frange)
[docs] def invertedFrameRange(self):
"""
Returns the inverse string formatted frame range of the sequence.
Will return an empty string if the sequence has no frame pattern.
Returns:
str:
Raises:
:class:`fileseq.exceptions.MaxSizeException`: If new inverted range
exceeded :const:`fileseq.constants.MAX_FRAME_SIZE`
"""
if not self._frameSet:
return ''
return self._frameSet.invertedFrameRange(self._zfill)
[docs] def start(self):
"""
Returns the start frame of the sequence's :class:`.FrameSet`.
Will return 0 if the sequence has no frame pattern.
Returns:
int:
"""
if not self._frameSet:
return 0
return self._frameSet.start()
[docs] def end(self):
"""
Returns the end frame of the sequences :class:`.FrameSet`.
Will return 0 if the sequence has no frame pattern.
Returns:
int:
"""
if not self._frameSet:
return 0
return self._frameSet.end()
[docs] def zfill(self):
"""
Returns the zfill depth (ie the number of zeroes to pad with).
Returns:
int:
"""
return self._zfill
[docs] def frame(self, frame):
"""
Return a path go the given frame in the sequence. Integer or string
digits are treated as a frame number and padding is applied, all other
values are passed though.
Examples:
>>> seq.frame(1)
/foo/bar.0001.exr
>>> seq.frame("#")
/foo/bar.#.exr
Args:
frame (int or str): the desired frame number or a char to pass
through (ie. #)
Returns:
str:
"""
try:
zframe = utils.asString(int(frame)).zfill(self._zfill)
except ValueError:
zframe = frame
# There may have been no placeholder for frame IDs in
# the sequence, in which case we don't want to insert
# a frame ID
if self._zfill == 0:
zframe = ""
return futils.native_str("".join((self._dir, self._base, zframe, self._ext)))
[docs] def index(self, idx):
"""
Return the path to the file at the given index.
Args:
idx (int): the desired index
Returns:
str:
"""
return self.__getitem__(idx)
[docs] def __iter__(self):
"""
Allow iteration over the path or paths this :class:`FileSequence`
represents.
Yields:
:class:`FileSequence`:
"""
# If there is no frame range, or there is no padding
# characters, then we only want to represent a single path
if not self._frameSet or not self._zfill:
yield utils.asString(self)
return
for f in self._frameSet:
yield self.frame(f)
[docs] def __getitem__(self, idx):
"""
Allows indexing and slicing into the underlying :class:`.FrameSet`
When indexing, a string filepath is returns for the frame.
When slicing, a new :class:`FileSequence` is returned.
Slicing outside the range of the sequence results in an
IndexError
Args:
idx (int or slice): the desired index
Returns:
str or :obj:`FileSequence`:
Raises:
:class:`IndexError`: If slice is outside the range of the sequence
"""
if not self._frameSet:
return utils.asString(self)
frames = self._frameSet[idx]
if not hasattr(idx, 'start'):
return self.frame(frames)
fset = FrameSet(frames)
if fset.is_null:
raise IndexError("slice is out of range and returns no frames")
fs = self.copy()
fs.setFrameSet(fset)
return fs
[docs] def __len__(self):
"""
The length (number of files) represented by this :class:`FileSequence`.
Returns:
int:
"""
if not self._frameSet or not self._zfill:
return 1
return len(self._frameSet)
def __str__(self):
"""
String representation of this :class:`FileSequence`.
Returns:
str:
"""
frameSet = utils.asString(self._frameSet or "")
return "".join((
self._dir,
self._base,
frameSet,
self._pad if frameSet else "",
self._ext))
def __repr__(self):
try:
return "<FileSequence: '%s'>" % str(self)
except TypeError:
return super(FileSequence, self).__repr__()
def __eq__(self, other):
return str(self) == str(other)
def __ne__(self, other):
return str(self) != str(other)
[docs] @staticmethod
def yield_sequences_in_list(paths):
"""
Yield the discrete sequences within paths. This does not try to
determine if the files actually exist on disk, it assumes you already
know that.
Args:
paths (list[str]): a list of paths
Yields:
:obj:`FileSequence`:
"""
seqs = {}
_check = DISK_RE.match
for match in filter(None, map(_check, map(utils.asString, paths))):
dirname, basename, frame, ext = match.groups()
if not basename and not ext:
continue
key = (dirname, basename, ext)
seqs.setdefault(key, set())
if frame:
seqs[key].add(frame)
for (dirname, basename, ext), frames in iteritems(seqs):
# build the FileSequence behind the scenes, rather than dupe work
seq = FileSequence.__new__(FileSequence)
seq._dir = dirname or ''
seq._base = basename or ''
seq._ext = ext or ''
if frames:
seq._frameSet = FrameSet(set(map(int, frames))) if frames else None
seq._pad = FileSequence.getPaddingChars(min(map(len, frames)))
else:
seq._frameSet = None
seq._pad = ''
seq.__init__(utils.asString(seq))
yield seq
[docs] @staticmethod
def findSequencesInList(paths):
"""
Returns the list of discrete sequences within paths. This does not try
to determine if the files actually exist on disk, it assumes you
already know that.
Args:
paths (list[str]): a list of paths
Returns:
list:
"""
return list(FileSequence.yield_sequences_in_list(paths))
[docs] @classmethod
def findSequencesOnDisk(cls, pattern, include_hidden=False, strictPadding=False):
"""
Yield the sequences found in the given directory.
Examples:
>>> findSequencesOnDisk('/path/to/files')
The `pattern` can also specify glob-like shell wildcards including the following:
* ``?`` - 1 wildcard character
* ``*`` - 1 or more wildcard character
* ``{foo,bar}`` - either 'foo' or 'bar'
Exact frame ranges are not considered, and padding characters are converted to
wildcards (``#`` or ``@``)
Examples:
>>> findSequencesOnDisk('/path/to/files/image_stereo_{left,right}.#.jpg')
>>> findSequencesOnDisk('/path/to/files/imag?_*_{left,right}.@@@.jpg', strictPadding=True)
Args:
pattern (str): directory to scan, or pattern to filter in directory
include_hidden (bool): if true, show .hidden files as well
strictPadding (bool): if True, ignore files with padding length different from pattern
Returns:
list:
"""
# reserve some functions we're going to need quick access to
_not_hidden = lambda f: not f.startswith('.')
_match_pattern = None
_filter_padding = None
_join = os.path.join
seq = None
dirpath = pattern
# Support the pattern defining a filter for the files
# in the existing directory
if not os.path.isdir(pattern):
dirpath, filepat = os.path.split(pattern)
if not os.path.isdir(dirpath):
return []
# Start building a regex for filtering files
seq = cls(filepat)
patt = seq.basename().replace('.', r'\.')
if seq.padding():
patt += r'\d+'
if seq.extension():
patt += seq.extension()
# Convert braces groups into regex capture groups
matches = re.finditer(r'{(.*?)(?:,(.*?))*}', patt)
for match in reversed(list(matches)):
i, j = match.span()
regex = '(%s)' % '|'.join([m.strip() for m in match.groups()])
patt = "".join((patt[0:i], regex, patt[j:]))
patt = patt.replace('*', '.*')
patt = patt.replace('?', '.')
patt += '$'
try:
_match_pattern = re.compile(str(patt)).match
except re.error:
msg = 'Invalid file pattern: {}'.format(filepat)
raise FileSeqException(msg)
if seq.padding() and strictPadding:
_filter_padding = functools.partial(cls._filterByPaddingNum, num=seq.zfill())
# Get just the immediate files under the dir.
# Avoids testing the os.listdir() for files as
# a second step.
ret = next(os.walk(dirpath), None)
files = ret[-1] if ret else []
# collapse some generators to get us the files that match our regex
if not include_hidden:
files = filter(_not_hidden, files)
# Filter by files that match the provided file pattern
if _match_pattern:
files = filter(_match_pattern, files)
# Filter by files that match the frame padding in the file pattern
if _filter_padding:
# returns a generator
files = _filter_padding(files)
# Ensure our dirpath ends with a path separator, so
# that we can control which sep is used during the
# os.path.join
sep = utils._getPathSep(dirpath)
if not dirpath.endswith(sep):
dirpath += sep
files = (_join(dirpath, f) for f in files)
files = list(files)
seqs = list(FileSequence.yield_sequences_in_list(files))
if _filter_padding and seq:
pad = cls.conformPadding(seq.padding())
# strict padding should preserve the original padding
# characters in the found sequences.
for s in seqs:
s.setPadding(pad)
return seqs
[docs] @classmethod
def findSequenceOnDisk(cls, pattern, strictPadding=False):
"""
Search for a specific sequence on disk.
The padding characters used in the `pattern` are used to filter the
frame values of the files on disk (if `strictPadding` is True).
Examples:
Find sequence matching basename and extension, and a wildcard for
any frame.
returns bar.1.exr bar.10.exr, bar.100.exr, bar.1000.exr, inclusive
>>> findSequenceOnDisk("seq/bar@@@@.exr")
Find exactly 4-padded sequence, i.e. seq/bar1-100#.exr
returns only frames bar1000.exr through bar9999.exr
>>> findSequenceOnDisk("seq/bar#.exr", strictPadding=True)
Args:
pattern (str): the sequence pattern being searched for
strictPadding (bool): if True, ignore files with padding length different from `pattern`
Returns:
str:
Raises:
:class:`.FileSeqException`: if no sequence is found on disk
"""
seq = cls(pattern)
if seq.frameRange() == '' and seq.padding() == '':
if os.path.isfile(pattern):
return seq
patt = seq.format('{dirname}{basename}*{extension}')
ext = seq.extension()
basename = seq.basename()
pad = seq.padding()
globbed = iglob(patt)
if pad and strictPadding:
globbed = cls._filterByPaddingNum(globbed, seq.zfill())
pad = cls.conformPadding(pad)
matches = cls.yield_sequences_in_list(globbed)
for match in matches:
if match.basename() == basename and match.extension() == ext:
if pad and strictPadding:
match.setPadding(pad)
return match
msg = 'no sequence found on disk matching {0}'
raise FileSeqException(msg.format(pattern))
@classmethod
def _filterByPaddingNum(cls, iterable, num):
"""
Yield only path elements from iterable which have a frame
padding that matches the given target padding number
Args:
iterable (collections.Iterable):
num (int):
Yields:
str:
"""
_check = DISK_RE.match
for item in iterable:
# Add a filter for paths that don't match the frame
# padding of a given number
matches = _check(item)
if not matches:
if num <= 0:
# Not a sequence pattern, but we were asked
# to match on a zero padding
yield item
continue
frame = matches.group(3) or ''
if not frame:
if num <= 0:
# No frame value was parsed, but we were asked
# to match on a zero padding
yield item
continue
# We have a frame number
if frame[0] == '0' or frame[:2] == '-0':
if len(frame) == num:
# A frame leading with '0' is explicitly
# padded and can only be a match if its exactly
# the target padding number
yield item
continue
if len(frame) >= num:
# A frame that does not lead with '0' can match
# a padding width >= to the target padding number
yield item
continue
[docs] @staticmethod
def getPaddingChars(num):
"""
Given a particular amount of padding, return the proper padding characters.
Args:
num (int):
Returns:
str:
"""
if num == 0:
return "@"
if num % 4 == 0:
return "#" * (num // 4)
else:
return "@" * num
[docs] @staticmethod
def getPaddingNum(chars):
"""
Given a supported group of padding characters, return the amount of padding.
Args:
chars (str): a supported group of padding characters
Returns:
int:
Raises:
ValueError: if unsupported padding character is detected
"""
match = PRINTF_SYNTAX_PADDING_RE.match(chars)
if match:
return int(match.group(1))
try:
rval = 0
for char in chars:
rval += PAD_MAP[char]
return rval
except KeyError:
msg = "Detected an unsupported padding character: \"{}\"."
msg += " Supported padding characters: {} or printf syntax padding"
msg += " %<int>d"
raise ValueError(msg.format(char, utils.asString(list(PAD_MAP))))