Module Import alias Import alias ImportFrom alias ClassDef bases body Expr Str Assign NameStore Lambda arguments args NameParam defaults NameLoad Assign NameStore Lambda arguments args NameParam defaults NameLoad FunctionDef arguments args NameParam NameParam NameParam defaults NameLoad body Assign AttributeStore NameLoad attr NameLoad Assign AttributeStore NameLoad attr Num Assign AttributeStore NameLoad attr NameLoad Assign AttributeStore NameLoad attr NameLoad Assign TupleStore AttributeStore NameLoad attr AttributeStore NameLoad attr Call AttributeLoad AttributeLoad NameLoad attr attr AttributeLoad NameLoad attr decorator_list FunctionDef arguments args NameParam defaults body Return AttributeLoad NameLoad attr decorator_list NameLoad FunctionDef arguments args NameParam defaults body If AttributeLoad NameLoad attr body Return Call AttributeLoad Str attr AttributeLoad NameLoad attr AttributeLoad NameLoad attr AttributeLoad NameLoad attr Return Call AttributeLoad Str attr AttributeLoad NameLoad attr AttributeLoad NameLoad attr decorator_list NameLoad FunctionDef arguments args NameParam defaults body Expr Str Return Call AttributeLoad AttributeLoad NameLoad attr attr AttributeLoad NameLoad attr decorator_list NameLoad FunctionDef arguments args NameParam defaults body Return Call AttributeLoad AttributeLoad NameLoad attr attr AttributeLoad NameLoad attr decorator_list NameLoad FunctionDef arguments args NameParam defaults body Return AttributeLoad NameLoad attr decorator_list NameLoad FunctionDef arguments args NameParam defaults body Return AttributeLoad NameLoad attr decorator_list NameLoad FunctionDef arguments args NameParam NameParam defaults NameLoad body Assign AttributeStore NameLoad attr NameLoad AugAssignAdd AttributeStore NameLoad attr Num Return NameLoad decorator_list FunctionDef arguments args NameParam NameParam defaults body Return Call AttributeLoad NameLoad attr Call AttributeLoad AttributeLoad NameLoad attr attr NameLoad keyword AttributeLoad NameLoad attr decorator_list FunctionDef arguments args NameParam defaults body Return Call AttributeLoad Str attr AttributeLoad AttributeLoad NameLoad attr attr AttributeLoad NameLoad attr AttributeLoad NameLoad attr decorator_list decorator_list ClassDef bases body Expr Str Assign NameStore NameLoad FunctionDef arguments args NameParam NameParam defaults body Expr Str If UnaryOpNot NameLoad body Raise Call AttributeLoad NameLoad attr Str If UnaryOpNot Call AttributeLoad NameLoad attr Str body Raise Call AttributeLoad NameLoad attr Call AttributeLoad Str attr NameLoad If CompareIn Str NameLoad body Raise Call AttributeLoad NameLoad attr Call AttributeLoad Str attr NameLoad Assign NameStore Call AttributeLoad AttributeLoad NameLoad attr attr NameLoad If BoolOpAnd UnaryOpNot CompareEq NameLoad Str Call AttributeLoad NameLoad attr Str body AugAssignAdd NameStore Str If UnaryOpNot CompareEq NameLoad NameLoad body Raise Call AttributeLoad NameLoad attr Call AttributeLoad Str attr NameLoad decorator_list NameLoad FunctionDef arguments args NameParam NameParam defaults body If UnaryOpNot AttributeLoad NameLoad attr body Raise Call AttributeLoad NameLoad attr Str keyword Num If AttributeLoad NameLoad attr body Raise Call AttributeLoad NameLoad attr Str keyword Num decorator_list NameLoad FunctionDef arguments args NameParam NameParam NameParam defaults NameLoad kwarg body Assign TupleStore NameStore NameStore TupleLoad ListLoad ListLoad For NameStore NameLoad body Expr Call AttributeLoad NameLoad attr AttributeLoad NameLoad attr Expr Call AttributeLoad NameLoad attr AttributeLoad NameLoad attr Assign NameStore Call AttributeLoad Str attr NameLoad If BoolOpAnd NameLoad UnaryOpNot NameLoad body Assign NameStore Str Return Call NameLoad NameLoad keyword NameLoad keyword NameLoad NameLoad decorator_list NameLoad FunctionDef arguments args NameParam NameParam NameParam NameParam NameParam defaults TupleLoad NameLoad NameLoad body Expr Call AttributeLoad AttributeLoad NameLoad attr attr NameLoad Assign AttributeStore NameLoad attr NameLoad Assign AttributeStore NameLoad attr NameLoad If NameLoad body Assign AttributeStore NameLoad attr ListComp Call AttributeLoad NameLoad attr NameLoad NameLoad comprehension NameStore Call AttributeLoad Call AttributeLoad NameLoad attr Str attr Str orelse Assign AttributeStore NameLoad attr ListLoad Assign AttributeStore NameLoad attr ListComp Call AttributeLoad NameLoad attr NameLoad NameLoad comprehension TupleStore NameStore NameStore Call AttributeLoad NameLoad attr NameLoad Call AttributeLoad Call AttributeLoad NameLoad attr Str attr Str If CompareIsNot NameLoad NameLoad body Assign AttributeStore NameLoad attr Call NameLoad NameLoad orelse Assign AttributeStore NameLoad attr Call AttributeLoad AttributeLoad NameLoad attr attr Str If BoolOpAnd AttributeLoad NameLoad attr UnaryOpNot Call AttributeLoad AttributeLoad NameLoad attr attr Str body AugAssignAdd AttributeStore NameLoad attr Str decorator_list FunctionDef arguments args NameParam defaults body Expr Str Return CompareEq Call NameLoad AttributeLoad NameLoad attr Num decorator_list NameLoad FunctionDef arguments args NameParam defaults body Expr Str Return AttributeLoad NameLoad attr decorator_list NameLoad FunctionDef arguments args NameParam defaults body Return AttributeLoad NameLoad attr decorator_list NameLoad FunctionDef arguments args NameParam defaults body Expr Str Return UnaryOpNot AttributeLoad NameLoad attr decorator_list NameLoad FunctionDef arguments args NameParam defaults body Expr Str Return IfExp AttributeLoad NameLoad attr Str Str decorator_list NameLoad FunctionDef arguments args NameParam defaults body Expr Str Return AttributeLoad NameLoad attr decorator_list NameLoad FunctionDef arguments args NameParam defaults body Expr Str Return AttributeLoad SubscriptLoad AttributeLoad NameLoad attr Index Num attr decorator_list NameLoad FunctionDef arguments args NameParam defaults body Expr Str Return AttributeLoad SubscriptLoad AttributeLoad NameLoad attr Index Num attr decorator_list NameLoad FunctionDef arguments args NameParam defaults body Expr Str Return BinOpAdd BinOpAdd Str AttributeLoad SubscriptLoad AttributeLoad NameLoad attr Index Num attr IfExp AttributeLoad NameLoad attr Str Str decorator_list NameLoad FunctionDef arguments args NameParam defaults body Expr Str Return AttributeLoad SubscriptLoad AttributeLoad NameLoad attr Index Num attr decorator_list NameLoad FunctionDef arguments args NameParam defaults body Expr Str If CompareEq Call NameLoad AttributeLoad NameLoad attr Num body Return Str Return BinOpAdd Call AttributeLoad Str attr ListComp AttributeLoad NameLoad attr comprehension NameStore SubscriptLoad AttributeLoad NameLoad attr Slice Num IfExp AttributeLoad NameLoad attr Str Str decorator_list NameLoad FunctionDef arguments args NameParam defaults body Expr Str If CompareEq Call NameLoad AttributeLoad NameLoad attr Num body Return Str Return BinOpAdd Call AttributeLoad Str attr ListComp AttributeLoad NameLoad attr comprehension NameStore SubscriptLoad AttributeLoad NameLoad attr Slice Num IfExp AttributeLoad NameLoad attr Str Str decorator_list NameLoad FunctionDef arguments args NameParam defaults body Expr Str Return BinOpAdd Call AttributeLoad Str attr ListComp AttributeLoad NameLoad attr comprehension NameStore BinOpAdd AttributeLoad NameLoad attr SubscriptLoad AttributeLoad NameLoad attr Slice Num IfExp AttributeLoad NameLoad attr Str Str decorator_list NameLoad FunctionDef arguments args NameParam defaults body Expr Str If CompareEq Call NameLoad AttributeLoad NameLoad attr Num body Return NameLoad Return Call AttributeLoad AttributeLoad NameLoad attr attr SubscriptLoad AttributeLoad NameLoad attr Slice Num keyword NameLoad keyword AttributeLoad NameLoad attr decorator_list NameLoad FunctionDef arguments args NameParam NameParam NameParam NameParam defaults NameLoad NameLoad body Expr Str Return Call AttributeLoad AttributeLoad NameLoad attr attr BinOpAdd AttributeLoad NameLoad attr ListLoad Call AttributeLoad NameLoad attr NameLoad keyword NameLoad keyword NameLoad keyword AttributeLoad NameLoad attr decorator_list FunctionDef arguments args NameParam defaults body Expr Call AttributeLoad SubscriptLoad AttributeLoad NameLoad attr Index Num attr Return NameLoad decorator_list FunctionDef arguments args NameParam NameParam defaults body Assign SubscriptStore AttributeLoad NameLoad attr Index Num Call AttributeLoad SubscriptLoad AttributeLoad NameLoad attr Index Num attr NameLoad Return NameLoad decorator_list FunctionDef arguments args NameParam NameParam defaults body Return BoolOpAnd Call NameLoad NameLoad AttributeLoad NameLoad attr CompareEq Call NameLoad NameLoad Call NameLoad NameLoad decorator_list FunctionDef arguments args NameParam defaults body Expr Str Return BinOpAdd Call AttributeLoad Str attr ListComp AttributeLoad NameLoad attr comprehension NameStore AttributeLoad NameLoad attr IfExp AttributeLoad NameLoad attr Str Str decorator_list FunctionDef arguments args NameParam defaults body Return Call AttributeLoad Str attr AttributeLoad AttributeLoad NameLoad attr attr AttributeLoad NameLoad attr AttributeLoad NameLoad attr decorator_list decorator_list
N/A N/A os N/A itertools waterbutler.core exceptions WaterButlerPathPart N/A N/A N/A  A WaterButlerPathPart represents one level of a unix-style path.  For instance,
    `/foo/bar/baz.txt` would be composed of four PathParts: the root, `foo`, `bar`, and `baz.txt`.
    Each PathPart has a `value`, an `_id`, a `count`, and an `ext`.  The `value` is the
    human-readable component of the path, such as `baz.txt` or `bar`.  The `_id` is the unique
    identifier for the PathPart.  This is optional.  Some providers use unique identifiers, others
    do not.  The `count` property is used for Mac-style renaming, where `(1)` is appended to a path
    name when a copy operation encounters a naming conflict.  `ext` is inferred from the initial
    path.
     N/A DECODE N/A N/A N/A x N/A x N/A ENCODE N/A N/A N/A x N/A x __init__ N/A N/A self part _id N/A None N/A N/A N/A self _id _id N/A N/A self _count 0 N/A N/A self _orig_id _id N/A N/A self _orig_part part N/A N/A N/A self _name N/A self _ext N/A N/A N/A os path splitext N/A self original_value N/A identifier N/A N/A self N/A N/A N/A N/A self _id N/A property value N/A N/A self N/A N/A N/A N/A self _count N/A N/A N/A N/A {} ({}){} format N/A self _name N/A self _count N/A self _ext N/A N/A N/A {}{} format N/A self _name N/A self _ext N/A property raw N/A N/A self N/A N/A N/A  The `value` as passed through the `ENCODE` function N/A N/A N/A N/A self __class__ ENCODE N/A self value N/A property original_value N/A N/A self N/A N/A N/A N/A N/A N/A self __class__ DECODE N/A self _orig_part N/A property original_raw N/A N/A self N/A N/A N/A N/A self _orig_part N/A property ext N/A N/A self N/A N/A N/A N/A self _ext N/A property increment_name N/A N/A self _id N/A None N/A N/A N/A self _id _id N/A N/A self _count 1 N/A self N/A renamed N/A N/A self name N/A N/A N/A N/A N/A self __class__ N/A N/A N/A self __class__ ENCODE name _id N/A self _id N/A __repr__ N/A N/A self N/A N/A N/A N/A N/A {}({!r}, count={}) format N/A N/A self __class__ __name__ N/A self _orig_part N/A self _count N/A N/A WaterButlerPath N/A N/A N/A  A standardized and validated immutable WaterButler path.  This is our abstraction around
    file paths in storage providers.  A WaterButlerPath is an array of WaterButlerPathPart objects.
    Each PathPart has two important attributes, `value` and `_id`.  `value` is always the
    human-readble component of the path. If the provider assigns ids to entities (see: Box, Google
    Drive, OSFStorage), that id belongs in the `_id` attribute. If `/Foo/Bar/baz.txt` is stored on
    Box, its path parts will be approximately::

        [
          { value: '/',       _id: None, }, # must have root
          { value: 'Foo',     _id: '1112192435' },
          { value: 'Bar',     _id: '1112202348' },
          { value: 'baz.txt', _id: '1113345897' },
        ]

    If :func:`WaterButlerPath.identifier` is called on this object, it'll return the `_id` of the
    last path part. :func:`WaterButlerPath.path` will return `/Foo/Bar/baz.txt`.

    A valid WaterButlerPath should always have a root path part.

    Some providers, such as Google Drive, require paths to be encoded when used in URLs.
    WaterButlerPathPart has `ENCODE` and `DECODE` class methods that handle this. The encoded path
    is available through the `.raw_path()` method.

    To get a human-readable materialized path, call `str()` on the WaterButlerPath.
     N/A PART_CLASS WaterButlerPathPart generic_path_validation N/A N/A cls path N/A N/A N/A Validates a WaterButler specific path, e.g. /folder/file.txt, /folder/
        :param str path: WaterButler path
         N/A N/A path N/A N/A N/A N/A exceptions InvalidPathError Must specify path N/A N/A N/A N/A path startswith / N/A N/A N/A N/A exceptions InvalidPathError N/A N/A Invalid path '{}' specified format path N/A N/A // path N/A N/A N/A N/A exceptions InvalidPathError N/A N/A Invalid path '{}' specified format path N/A absolute_path N/A N/A N/A os path abspath path N/A N/A N/A N/A path / N/A N/A path endswith / N/A N/A absolute_path / N/A N/A N/A path absolute_path N/A N/A N/A N/A exceptions InvalidPathError N/A N/A Invalid path '{}' specified format absolute_path N/A classmethod validate_folder N/A N/A cls path N/A N/A N/A N/A N/A path is_dir N/A N/A N/A N/A exceptions CreateFolderError Path must be a directory code 400 N/A N/A path is_root N/A N/A N/A N/A exceptions CreateFolderError Path can not be root code 400 N/A classmethod from_parts N/A N/A cls parts folder N/A False kwargs N/A N/A N/A _ids _parts N/A N/A N/A N/A part parts N/A N/A N/A N/A _ids append N/A part identifier N/A N/A N/A _parts append N/A part raw N/A path N/A N/A / join _parts N/A N/A parts N/A path N/A N/A path / N/A N/A cls path _ids _ids folder folder kwargs N/A classmethod __init__ N/A N/A self path _ids prepend folder N/A N/A None None N/A N/A N/A N/A N/A self __class__ generic_path_validation path N/A N/A self _orig_path path N/A N/A self _prepend prepend N/A prepend N/A N/A N/A self _prepend_parts N/A N/A N/A self PART_CLASS part None N/A part N/A N/A N/A N/A prepend rstrip / split / N/A N/A N/A self _prepend_parts N/A N/A N/A self _parts N/A N/A N/A self PART_CLASS part _id N/A N/A _id part N/A N/A itertools zip_longest _ids N/A N/A N/A N/A path rstrip / split / N/A N/A folder None N/A N/A N/A self _is_folder N/A bool folder N/A N/A N/A self _is_folder N/A N/A N/A self _orig_path endswith / N/A N/A N/A self is_dir N/A N/A N/A N/A self _orig_path endswith / N/A N/A N/A self _orig_path / N/A is_root N/A N/A self N/A N/A N/A  Returns `True` if the path is the root directory.  N/A N/A N/A len N/A self _parts 1 N/A property is_dir N/A N/A self N/A N/A N/A  Returns `True` if the path represents a folder.  N/A N/A self _is_folder N/A property is_folder N/A N/A self N/A N/A N/A N/A self _is_folder N/A property is_file N/A N/A self N/A N/A N/A  Returns `True` if the path represents a file.  N/A N/A N/A self _is_folder N/A property kind N/A N/A self N/A N/A N/A  Returns `folder` if the path represents a folder, otherwise returns `file`.  N/A N/A N/A self _is_folder folder file N/A property parts N/A N/A self N/A N/A N/A  Returns the list of WaterButlerPathParts that comprise this WaterButlerPath.  N/A N/A self _parts N/A property name N/A N/A self N/A N/A N/A  Returns the name of the file or folder.  N/A N/A N/A N/A self _parts N/A -1 value N/A property identifier N/A N/A self N/A N/A N/A  Returns the ID of the file or folder.  N/A N/A N/A N/A self _parts N/A -1 identifier N/A property identifier_path N/A N/A self N/A N/A N/A  Returns the ID formatted as a path for providers that use unique ids

        Quirk:
            If identifier is not set raises TypeError
         N/A N/A N/A / N/A N/A N/A self _parts N/A -1 identifier N/A N/A self is_dir / N/A property ext N/A N/A self N/A N/A N/A  Return the extension of the file  N/A N/A N/A N/A self _parts N/A -1 ext N/A property path N/A N/A self N/A N/A N/A  Returns a unix-style human readable path, relative to the provider storage root.
        Does NOT include a leading slash.  Calling `.path()` on the storage root returns the
        empty string.
         N/A N/A N/A len N/A self parts 1 N/A N/A N/A N/A N/A N/A / join N/A N/A x value N/A x N/A N/A self parts N/A 1 N/A N/A self is_dir / N/A property raw_path N/A N/A self N/A N/A N/A  Like `.path()`, but passes each path segment through the PathPart's ENCODE function.
         N/A N/A N/A len N/A self parts 1 N/A N/A N/A N/A N/A N/A / join N/A N/A x raw N/A x N/A N/A self parts N/A 1 N/A N/A self is_dir / N/A property full_path N/A N/A self N/A N/A N/A  Same as `.path()`, but with the provider storage root prepended.  N/A N/A N/A N/A / join N/A N/A x value N/A x N/A N/A self _prepend_parts N/A N/A self parts N/A 1 N/A N/A self is_dir / N/A property parent N/A N/A self N/A N/A N/A  Returns a new WaterButlerPath that represents the parent of the current path.

        Calling `.parent()` on the root path returns None.
         N/A N/A N/A len N/A self parts 1 N/A N/A None N/A N/A N/A N/A self __class__ from_parts N/A N/A self parts N/A -1 folder True prepend N/A self _prepend N/A property child N/A N/A self name _id folder N/A None False N/A N/A  Create a child of the current WaterButlerPath, propagating prepend and id information to it.

        :param str name: the name of the child entity
        :param _id: the id of the child entity (defaults to None)
        :param bool folder: whether or not the child is a folder (defaults to False)
         N/A N/A N/A N/A self __class__ from_parts N/A N/A self parts N/A N/A N/A self PART_CLASS name _id _id folder folder prepend N/A self _prepend N/A increment_name N/A N/A self N/A N/A N/A N/A N/A N/A N/A self _parts N/A -1 increment_name N/A self N/A rename N/A N/A self name N/A N/A N/A N/A N/A self _parts N/A -1 N/A N/A N/A N/A self _parts N/A -1 renamed name N/A self N/A __eq__ N/A N/A self other N/A N/A N/A N/A N/A isinstance other N/A self __class__ N/A N/A str self N/A str other N/A __str__ N/A N/A self N/A N/A N/A  Returns the materialized path  N/A N/A N/A N/A / join N/A N/A x value N/A x N/A self parts N/A N/A self is_dir / N/A __repr__ N/A N/A self N/A N/A N/A N/A N/A {}({!r}, prepend={!r}) format N/A N/A self __class__ __name__ N/A self _orig_path N/A self _prepend N/A N/A