Module Import alias Import alias Import alias Import alias Import alias ImportFrom alias ImportFrom alias alias alias ImportFrom alias ImportFrom alias ImportFrom alias ImportFrom alias ImportFrom alias ClassDef bases AttributeLoad NameLoad attr NameLoad body Expr Str FunctionDef arguments args NameParam defaults body Assign AttributeStore NameLoad attr Str Expr Call AttributeLoad NameLoad attr TupleLoad Str Str Str TupleLoad ListLoad TupleLoad Str Num TupleLoad Str Num Dict Expr Call AttributeLoad NameLoad attr Dict Str Str Num Num Assign AttributeStore NameLoad attr Str Assign AttributeStore NameLoad attr Str Expr Call AttributeLoad NameLoad attr keyword AttributeLoad NameLoad attr keyword TupleLoad Str Str Str Str Str Str Str Str Str Str Str decorator_list FunctionDef arguments args NameParam defaults vararg kwarg body Expr Str If CompareIn Str NameLoad body Assign NameStore BinOpAdd ListLoad Call AttributeLoad NameLoad attr Str Call NameLoad NameLoad Return Call AttributeLoad NameLoad attr NameLoad NameLoad NameLoad decorator_list FunctionDef arguments args NameParam NameParam defaults body Expr Str If CompareIs NameLoad NameLoad body Assign NameStore Str If UnaryOpNot Call NameLoad NameLoad AttributeLoad NameLoad attr body Assign NameStore Call NameLoad NameLoad Return Call AttributeLoad NameLoad attr decorator_list FunctionDef arguments args NameParam NameParam defaults body Assign SubscriptStore NameLoad Index Str Call AttributeLoad NameLoad attr Call AttributeLoad NameLoad attr Str Str Assign SubscriptStore NameLoad Index Str Call AttributeLoad NameLoad attr Call AttributeLoad NameLoad attr Str Str If UnaryOpNot SubscriptLoad NameLoad Index Str body Raise Call NameLoad Str Str Assign NameStore SubscriptLoad NameLoad Index Str Assign NameStore Num While NameLoad body Assign NameStore Dict Str Str NameLoad SubscriptLoad NameLoad Index Str If CompareIn Str NameLoad body Assign SubscriptStore NameLoad Index Str Dict Str SubscriptLoad NameLoad Index Str Assign NameStore Call AttributeLoad NameLoad attr NameLoad keyword ListLoad Str Assign NameStore Dict Str Str Str SubscriptLoad NameLoad Index Str NameLoad Str Assign NameStore Call AttributeLoad Call AttributeLoad NameLoad attr Str attr NameLoad keyword ListLoad Str If BoolOpAnd CompareIs NameLoad NameLoad CompareIs NameLoad NameLoad body Assign SubscriptStore NameLoad Index Str NameLoad Break orelse AugAssignAdd NameStore Num Assign NameStore BinOpMod Str TupleLoad SubscriptLoad NameLoad Index Str NameLoad Assign SubscriptStore NameLoad Index Str Call AttributeLoad SubscriptLoad NameLoad Index Str attr Return NameLoad decorator_list FunctionDef arguments args NameParam NameParam NameParam NameParam NameParam NameParam NameParam NameParam defaults AttributeLoad NameLoad attr NameLoad NameLoad NameLoad NameLoad NameLoad body Expr Str Assign NameStore Call AttributeLoad Call NameLoad NameLoad NameLoad attr NameLoad NameLoad NameLoad NameLoad NameLoad NameLoad NameLoad If BoolOpAnd CompareIsNot NameLoad NameLoad CompareNotIn Str NameLoad body Assign NameStore Call AttributeLoad NameLoad attr NameLoad keyword NameLoad keyword NameLoad Assign NameStore SubscriptLoad NameLoad Index Num Assign SubscriptStore NameLoad Index Str SubscriptLoad SubscriptLoad NameLoad Index Str Index Str Assign SubscriptStore NameLoad Index Str SubscriptLoad NameLoad Index Str Expr Call AttributeLoad NameLoad attr NameLoad keyword NameLoad If BoolOpAnd CompareIsNot NameLoad NameLoad CompareNotIn Str NameLoad body Expr Call AttributeLoad NameLoad attr NameLoad keyword NameLoad Return NameLoad decorator_list FunctionDef arguments args NameParam NameParam NameParam defaults body Expr Str Expr Call AttributeLoad NameLoad attr NameLoad UnaryOpUSub SubscriptLoad NameLoad Index Str Assign SubscriptStore NameLoad Index Str SubscriptLoad NameLoad Index Str Assign SubscriptStore NameLoad Index Str SubscriptLoad NameLoad Index Str Assign SubscriptStore NameLoad Index Str SubscriptLoad NameLoad Index Str Expr Call AttributeLoad NameLoad attr NameLoad SubscriptLoad NameLoad Index Str Return Call AttributeLoad NameLoad attr NameLoad decorator_list FunctionDef arguments args NameParam NameParam NameParam defaults body Expr Call AttributeLoad Call AttributeLoad NameLoad attr Str attr keyword Dict Str SubscriptLoad NameLoad Index Str keyword Str keyword NameLoad keyword NameLoad Expr Call AttributeLoad Call AttributeLoad NameLoad attr SubscriptLoad NameLoad Index Str attr keyword Dict Str SubscriptLoad NameLoad Index Str keyword Str keyword NameLoad keyword NameLoad decorator_list FunctionDef arguments args NameParam NameParam defaults body Expr Str Assign NameStore Num For NameStore Call AttributeLoad NameLoad attr NameLoad body AugAssignAdd NameStore Call AttributeLoad NameLoad attr Str Num Assign NameStore BinOpSub NameLoad Call AttributeLoad NameLoad attr Str Num If NameLoad body Expr Call AttributeLoad NameLoad attr BinOpMod Str TupleLoad SubscriptLoad NameLoad Index Str SubscriptLoad NameLoad Index Str NameLoad Assign SubscriptStore NameLoad Index Str NameLoad Expr Call AttributeLoad NameLoad attr Dict Str SubscriptLoad NameLoad Index Str keyword Dict Str Dict Str NameLoad Expr Call AttributeLoad NameLoad attr NameLoad NameLoad Return NameLoad decorator_list FunctionDef arguments args NameParam NameParam NameParam NameParam NameParam defaults Num Num NameLoad kwarg body Expr Str Assign NameStore Dict Str SubscriptLoad NameLoad Index Str Return Call AttributeLoad Call AttributeLoad NameLoad attr Str attr NameLoad keyword NameLoad keyword NameLoad keyword NameLoad NameLoad decorator_list FunctionDef arguments args NameParam NameParam defaults kwarg body Expr Str Assign NameStore Call AttributeLoad Call AttributeLoad NameLoad attr Str attr Dict Str SubscriptLoad NameLoad Index Str For NameStore NameLoad body Assign NameStore Call AttributeLoad NameLoad attr Expr Call AttributeLoad NameLoad attr Str NameLoad Expr Call AttributeLoad Call AttributeLoad NameLoad attr Str attr NameLoad keyword NameLoad NameLoad Assign NameStore Call AttributeLoad Call AttributeLoad NameLoad attr Str attr Dict Str Str SubscriptLoad NameLoad Index Str Str For NameStore NameLoad body Expr Call AttributeLoad Call AttributeLoad NameLoad attr Str attr NameLoad NameLoad Expr Call AttributeLoad NameLoad attr NameLoad NameLoad decorator_list FunctionDef arguments args NameParam NameParam NameParam NameParam NameParam NameParam defaults Str NameLoad body Expr Str If NameLoad body Assign NameStore Call AttributeLoad NameLoad attr Dict Str Str SubscriptLoad NameLoad Index Str NameLoad If NameLoad body Return NameLoad Assign NameStore Call AttributeLoad AttributeLoad NameLoad attr attr If BoolOpOr UnaryOpNot Call NameLoad NameLoad NameLoad CompareNotIn Str NameLoad body Raise Call NameLoad Str Str If CompareNotIn Str NameLoad body Assign NameStore Call AttributeLoad NameLoad attr Dict Str SubscriptLoad NameLoad Index Str NameLoad keyword NameLoad Assign SubscriptStore NameLoad Index Str SubscriptLoad SubscriptLoad NameLoad Index Num Index Str Assign SubscriptStore NameLoad Index Str SubscriptLoad SubscriptLoad SubscriptLoad NameLoad Index Num Index Str Index Str Return Call AttributeLoad NameLoad attr Dict Str Str Str Str Str Str Str Str Str Call AttributeLoad NameLoad attr NameLoad Call AttributeLoad NameLoad attr NameLoad Call NameLoad SubscriptLoad NameLoad Index Str SubscriptLoad NameLoad Index Str SubscriptLoad NameLoad Index Str SubscriptLoad NameLoad Index Str NameLoad NameLoad Num decorator_list FunctionDef arguments args NameParam NameParam defaults body Expr Str Assign SubscriptStore NameLoad Index Str Call AttributeLoad AttributeLoad NameLoad attr attr Return Call AttributeLoad NameLoad attr NameLoad decorator_list FunctionDef arguments args NameParam NameParam NameParam defaults body Expr Str If CompareNotIn Str NameLoad body Assign SubscriptStore NameLoad Index Str Dict Expr Call AttributeLoad SubscriptLoad NameLoad Index Str attr Call AttributeLoad NameLoad attr NameLoad Assign NameStore ListComp NameLoad comprehension TupleStore NameStore NameStore Call AttributeLoad NameLoad attr SubscriptLoad NameLoad Index Str CompareIs NameLoad NameLoad For NameStore NameLoad body Delete SubscriptDel SubscriptLoad NameLoad Index Str Index NameLoad Assign SubscriptStore NameLoad Index Str Call AttributeLoad AttributeLoad NameLoad attr attr Return Call AttributeLoad NameLoad attr NameLoad decorator_list FunctionDef arguments args NameParam NameParam NameParam NameParam defaults NameLoad NameLoad body Expr Str Assign NameStore Call AttributeLoad Call AttributeLoad NameLoad attr Str attr SubscriptLoad NameLoad Index Str keyword NameLoad keyword AttributeLoad NameLoad attr keyword NameLoad Assign NameStore Call AttributeLoad Call AttributeLoad NameLoad attr Str attr NameLoad keyword NameLoad keyword AttributeLoad NameLoad attr keyword NameLoad If NameLoad body Expr Call AttributeLoad NameLoad attr Dict Str Str Str NameLoad orelse Assign NameStore Call AttributeLoad Call AttributeLoad NameLoad attr Str attr NameLoad NameLoad Expr Call AttributeLoad NameLoad attr Dict Str Str Str NameLoad Return NameLoad decorator_list FunctionDef arguments args NameParam NameParam NameParam NameParam NameParam NameParam defaults NameLoad NameLoad NameLoad body Expr Str If CompareIs NameLoad NameLoad body Assign NameStore SubscriptLoad NameLoad Index Str If CompareIs NameLoad NameLoad body Assign NameStore Call AttributeLoad Call AttributeLoad NameLoad attr Str attr SubscriptLoad NameLoad Index Str keyword NameLoad If CompareIs NameLoad NameLoad body Assign NameStore SubscriptLoad NameLoad Index Str Assign NameStore Call AttributeLoad NameLoad attr keyword NameLoad keyword NameLoad keyword NameLoad keyword NameLoad Assign NameStore Call AttributeLoad NameLoad attr NameLoad NameLoad Assign NameStore NameLoad For NameStore NameLoad body If BoolOpAnd CompareNotIn NameLoad NameLoad CompareNotIn NameLoad NameLoad body Assign SubscriptStore NameLoad Index NameLoad Call AttributeLoad NameLoad attr SubscriptLoad NameLoad Index NameLoad Assign NameStore NameLoad If NameLoad body Expr Call AttributeLoad NameLoad attr NameLoad keyword NameLoad Expr Call AttributeLoad NameLoad attr Str TupleLoad NameLoad NameLoad For NameStore Call AttributeLoad NameLoad attr keyword NameLoad body Expr Call AttributeLoad Call AttributeLoad NameLoad attr Str attr NameLoad keyword NameLoad keyword NameLoad Assign NameStore Call AttributeLoad NameLoad attr SubscriptLoad NameLoad Index Str keyword NameLoad Expr Call AttributeLoad NameLoad attr Str NameLoad Return NameLoad decorator_list FunctionDef arguments args NameParam NameParam NameParam NameParam NameParam NameParam defaults NameLoad Str NameLoad NameLoad body Expr Str If NameLoad body Assign NameStore Call NameLoad Call AttributeLoad NameLoad attr keyword NameLoad keyword Num If BoolOpOr CompareNotEq Call NameLoad NameLoad Num CompareNotEq SubscriptLoad SubscriptLoad NameLoad Index Num Index Str SubscriptLoad NameLoad Index Str BoolOpAnd NameLoad Call AttributeLoad NameLoad attr Str Dict body Assign NameStore Call AttributeLoad AttributeLoad NameLoad attr attr NameLoad SubscriptLoad NameLoad Index Str Assign NameStore Str For NameStore Call AttributeLoad NameLoad attr keyword NameLoad body If CompareEq SubscriptLoad NameLoad Index Str NameLoad body Assign NameStore NameLoad Expr Yield TupleLoad Call AttributeLoad AttributeLoad NameLoad attr attr NameLoad SubscriptLoad NameLoad Index Str Call AttributeLoad Call AttributeLoad NameLoad attr Str attr NameLoad keyword NameLoad If BoolOpAnd NameLoad NameLoad Call NameLoad Call AttributeLoad NameLoad attr Str Dict body FunctionDef arguments args defaults body Expr Yield Call AttributeLoad NameLoad attr SubscriptLoad NameLoad Index Str keyword NameLoad decorator_list Expr Yield TupleLoad Call AttributeLoad AttributeLoad NameLoad attr attr NameLoad NameLoad NameLoad decorator_list FunctionDef arguments args NameParam NameParam NameParam defaults NameLoad body Expr Str If CompareEq NameLoad Str body Assign NameStore Call AttributeLoad Call AttributeLoad NameLoad attr keyword Num attr Return TupleLoad NameLoad Num orelse If CompareEq NameLoad Str body Assign NameStore Call AttributeLoad AttributeLoad Call AttributeLoad NameLoad attr Str attr attr Str Assign NameStore Call AttributeLoad NameLoad attr Dict Str ListLoad Dict Str Dict Str NameLoad Dict Str Dict Str NameLoad Assign NameStore NameStore Call AttributeLoad NameLoad attr If NameLoad body If CompareIsNot NameLoad NameLoad body Expr Call AttributeLoad NameLoad attr keyword Str For NameStore NameLoad body Expr Call NameLoad Expr Call AttributeLoad AttributeLoad NameLoad attr attr Dict Str SubscriptLoad NameLoad Index Str If CompareIsNot NameLoad NameLoad body AugAssignSub NameStore Num Expr Call AttributeLoad NameLoad attr keyword Num keyword BinOpMod Str NameLoad Return TupleLoad NameLoad NameLoad orelse If CompareEq NameLoad Str body Assign NameStore Call AttributeLoad NameLoad attr Assign NameStore NameStore Call AttributeLoad NameLoad attr Assign NameStore Num If CompareIsNot NameLoad NameLoad body Expr Call AttributeLoad NameLoad attr keyword Str For NameStore NameLoad body Assign NameStore NameLoad Expr Call NameLoad Assign NameStore Call AttributeLoad NameLoad attr Str Num Assign NameStore Call AttributeLoad NameLoad attr NameLoad If CompareNotEq NameLoad NameLoad body Assign NameStore NameLoad Assign NameStore SubscriptLoad Call AttributeLoad NameLoad attr NameLoad keyword NameLoad Index Num If BoolOpOr CompareNotEq SubscriptLoad NameLoad Index Str SubscriptLoad NameLoad Index Str CompareNotEq SubscriptLoad NameLoad Index Str SubscriptLoad SubscriptLoad NameLoad Index Str Index Str body Expr Call AttributeLoad NameLoad attr Dict Str SubscriptLoad NameLoad Index Str keyword Dict Str Dict Str Str SubscriptLoad NameLoad Index Str SubscriptLoad SubscriptLoad NameLoad Index Str Index Str Assign NameStore NameLoad If NameLoad body AugAssignAdd NameStore Num If CompareIsNot NameLoad NameLoad body AugAssignSub NameStore Num Expr Call AttributeLoad NameLoad attr keyword Num keyword BinOpMod Str NameLoad Return TupleLoad NameLoad NameLoad decorator_list decorator_list
N/A N/A copy N/A datetime N/A json N/A os N/A six bson.objectid ObjectId model_base Model ValidationException GirderException girder events girder logger girder.constants AccessType girder.utility acl_mixin girder.utility.progress setResponseTimeLimit Item N/A N/A acl_mixin AccessControlMixin Model N/A N/A 
    Items are leaves in the data hierarchy. They can contain 0 or more
    files within them, and can also contain arbitrary metadata.
     initialize N/A N/A self N/A N/A N/A N/A self name item N/A N/A N/A self ensureIndices N/A folderId name lowerName N/A N/A N/A folderId 1 N/A name 1 N/A N/A N/A N/A self ensureTextIndex N/A name description 10 1 N/A N/A self resourceColl folder N/A N/A self resourceParent folderId N/A N/A N/A self exposeFields level N/A AccessType READ fields N/A _id size updated description created meta creatorId folderId name baseParentType baseParentId N/A filter N/A N/A self N/A args kwargs N/A N/A 
        Preserved override for kwarg backwards compatibility. Prior to the
        refactor for centralizing model filtering, this method's first formal
        parameter was called "item", whereas the centralized version's first
        parameter is called "doc". This override simply detects someone using
        the old kwarg and converts it to the new form.
         N/A N/A item kwargs N/A N/A args N/A N/A N/A N/A kwargs pop item N/A list args N/A N/A N/A Model filter self args kwargs N/A _validateString N/A N/A self value N/A N/A N/A 
        Make sure a value is a string and is stripped of whitespace.

        :param value: the value to coerce into a string if it isn't already.
        :returns: the string version of the value.
         N/A N/A value None N/A N/A value N/A N/A N/A isinstance value N/A six string_types N/A N/A value N/A str value N/A N/A N/A value strip N/A validate N/A N/A self doc N/A N/A N/A N/A doc N/A name N/A N/A self _validateString N/A N/A doc get name N/A N/A doc N/A description N/A N/A self _validateString N/A N/A doc get description N/A N/A N/A doc N/A name N/A N/A N/A ValidationException Item name must not be empty. name N/A name N/A doc N/A name N/A n 0 N/A True N/A N/A q N/A name folderId name N/A doc N/A folderId N/A N/A _id doc N/A N/A N/A q N/A _id N/A $ne N/A doc N/A _id N/A dupItem N/A N/A self findOne q fields N/A _id N/A q N/A parentId name parentCollection N/A doc N/A folderId name folder N/A dupFolder N/A N/A N/A N/A self model folder findOne q fields N/A _id N/A N/A N/A dupItem None N/A dupFolder None N/A N/A N/A doc N/A name name N/A N/A N/A n 1 N/A name N/A %s (%d) N/A N/A doc N/A name n N/A N/A doc N/A lowerName N/A N/A N/A doc N/A name lower N/A doc N/A load N/A N/A self id level user objectId force fields exc N/A N/A AccessType ADMIN None True False None False N/A N/A 
        Calls AccessControlMixin.load while doing some auto-correction.

        Takes the same parameters as
        :py:func:`girder.models.model_base.AccessControlledMixin.load`.
         N/A doc N/A N/A N/A super Item self load id level user objectId force fields exc N/A N/A N/A doc None N/A baseParentType doc N/A N/A pathFromRoot N/A N/A self parentsToRoot doc user user force True N/A baseParent N/A pathFromRoot N/A 0 N/A N/A doc N/A baseParentId N/A N/A baseParent N/A object N/A _id N/A N/A doc N/A baseParentType N/A baseParent N/A type N/A N/A N/A self save doc triggerEvents False N/A N/A N/A doc None N/A lowerName doc N/A N/A N/A N/A self save doc triggerEvents False N/A doc N/A move N/A N/A self item folder N/A N/A N/A 
        Move the given item from its current folder into another folder.

        :param item: The item to move.
        :type item: dict
        :param folder: The folder to move the item into.
        :type folder: dict.
         N/A N/A N/A self propagateSizeChange item N/A N/A item N/A size N/A N/A item N/A folderId N/A folder N/A _id N/A N/A item N/A baseParentType N/A folder N/A baseParentType N/A N/A item N/A baseParentId N/A folder N/A baseParentId N/A N/A N/A self propagateSizeChange item N/A item N/A size N/A N/A N/A self save item N/A propagateSizeChange N/A N/A self item inc N/A N/A N/A N/A N/A N/A N/A self model folder increment query N/A _id N/A item N/A folderId field size amount inc multi False N/A N/A N/A N/A N/A self model N/A item N/A baseParentType increment query N/A _id N/A item N/A baseParentId field size amount inc multi False N/A recalculateSize N/A N/A self item N/A N/A N/A 
        Recalculate the item size based on the files that are in it.  If this
        is different than the recorded size, propagate the changes.
        :param item: The item to recalculate the size of.
        :returns: the recalculated size in bytes
         N/A size 0 N/A file N/A N/A self childFiles item N/A N/A size N/A N/A file get size 0 N/A delta N/A size N/A N/A item get size 0 N/A delta N/A N/A N/A N/A logger info N/A Item %s was wrong size: was %d, is %d N/A N/A item N/A _id N/A item N/A size size N/A N/A item N/A size size N/A N/A N/A self update N/A _id N/A item N/A _id update N/A $set N/A size size N/A N/A N/A self propagateSizeChange item delta N/A size N/A childFiles N/A N/A self item limit offset sort N/A 0 0 None kwargs N/A N/A 
        Returns child files of the item.  Passes any kwargs to the find
        function.

        :param item: The parent item.
        :param limit: Result limit.
        :param offset: Result offset.
        :param sort: The sort structure to pass to pymongo.
         N/A q N/A itemId N/A item N/A _id N/A N/A N/A N/A N/A self model file find q limit limit offset offset sort sort kwargs N/A remove N/A N/A self item N/A kwargs N/A N/A 
        Delete an item, and all references to it in the database.

        :param item: The item document to delete.
        :type item: dict
         N/A files N/A N/A N/A N/A self model file find N/A itemId N/A item N/A _id N/A file files N/A N/A fileKwargs N/A N/A kwargs copy N/A N/A N/A fileKwargs pop updateItemSize None N/A N/A N/A N/A N/A self model file remove file updateItemSize False fileKwargs N/A uploads N/A N/A N/A N/A self model upload find N/A parentId parentType N/A item N/A _id item N/A upload uploads N/A N/A N/A N/A N/A N/A self model upload remove upload kwargs N/A N/A N/A Model remove self item N/A createItem N/A N/A self name creator folder description reuseExisting N/A False N/A N/A 
        Create a new item. The creator will be given admin access to it.

        :param name: The name of the item.
        :type name: str
        :param description: Description for the item.
        :type description: str
        :param folder: The parent folder of the item.
        :param creator: User document representing the creator of the item.
        :type creator: dict
        :param reuseExisting: If an item with the given name already exists
            under the given folder, return that item rather than creating a
            new one.
        :type reuseExisting: bool
        :returns: The item document that was created.
         N/A reuseExisting N/A N/A existing N/A N/A self findOne N/A folderId name N/A folder N/A _id name N/A existing N/A N/A existing N/A now N/A N/A N/A datetime datetime utcnow N/A N/A N/A N/A isinstance creator dict N/A _id creator N/A N/A N/A GirderException Creator must be a user. girder.models.item.creator-not-user N/A N/A baseParentType folder N/A N/A pathFromRoot N/A N/A self parentsToRoot N/A folderId N/A folder N/A _id creator force True N/A N/A folder N/A baseParentType N/A N/A pathFromRoot N/A 0 N/A type N/A N/A folder N/A baseParentId N/A N/A N/A pathFromRoot N/A 0 N/A object N/A _id N/A N/A N/A self save N/A name description folderId creatorId baseParentType baseParentId created updated size N/A N/A self _validateString name N/A N/A self _validateString description N/A ObjectId N/A folder N/A _id N/A creator N/A _id N/A folder N/A baseParentType N/A folder N/A baseParentId now now 0 N/A updateItem N/A N/A self item N/A N/A N/A 
        Updates an item.

        :param item: The item document to update
        :type item: dict
        :returns: The item document that was edited.
         N/A N/A item N/A updated N/A N/A N/A datetime datetime utcnow N/A N/A N/A self save item N/A setMetadata N/A N/A self item metadata N/A N/A N/A 
        Set metadata on an item.  A `ValidationException` is thrown in the
        cases where the metadata JSON object is badly formed, or if any of the
        metadata keys contains a period ('.').

        :param item: The item to set the metadata on.
        :type item: dict
        :param metadata: A dictionary containing key-value pairs to add to
                     the items meta field
        :type metadata: dict
        :returns: the item document
         N/A N/A meta item N/A N/A N/A item N/A meta N/A N/A N/A N/A N/A item N/A meta update N/A N/A six viewitems metadata N/A toDelete N/A k N/A N/A k v N/A N/A six viewitems N/A item N/A meta N/A v None N/A key toDelete N/A N/A N/A N/A item N/A meta N/A key N/A N/A item N/A updated N/A N/A N/A datetime datetime utcnow N/A N/A N/A self save item N/A parentsToRoot N/A N/A self item user force N/A None False N/A N/A 
        Get the path to traverse to a root of the hierarchy.

        :param item: The item whose root to find
        :type item: dict
        :param user: The user making the request (not required if force=True).
        :type user: dict or None
        :param force: Set to True to skip permission checking. If False, the
            returned models will be filtered.
        :type force: bool
        :returns: an ordered list of dictionaries from root to the current item
         N/A curFolder N/A N/A N/A N/A self model folder load N/A item N/A folderId user user level N/A AccessType READ force force N/A folderIdsToRoot N/A N/A N/A N/A self model folder parentsToRoot curFolder user user level N/A AccessType READ force force N/A force N/A N/A N/A N/A folderIdsToRoot append N/A type object folder curFolder N/A N/A filteredFolder N/A N/A N/A N/A self model folder filter curFolder user N/A N/A N/A folderIdsToRoot append N/A type object folder filteredFolder N/A folderIdsToRoot N/A copyItem N/A N/A self srcItem creator name folder description N/A None None None N/A N/A 
        Copy an item, including duplicating files and metadata.

        :param srcItem: the item to copy.
        :type srcItem: dict
        :param creator: the user who will own the copied item.
        :param name: The name of the new item.  None to copy the original name.
        :type name: str
        :param folder: The parent folder of the new item.  None to store in the
                same folder as the original item.
        :param description: Description for the new item.  None to copy the
                original description.
        :type description: str
        :returns: the new item.
         N/A N/A name None N/A N/A name N/A srcItem N/A name N/A N/A folder None N/A N/A folder N/A N/A N/A N/A self model folder load N/A srcItem N/A folderId force True N/A N/A description None N/A N/A description N/A srcItem N/A description N/A newItem N/A N/A self createItem folder folder name name creator creator description description N/A filteredItem N/A N/A self filter newItem creator N/A updated False N/A key srcItem N/A N/A N/A N/A key filteredItem N/A key newItem N/A N/A N/A newItem N/A key N/A N/A copy deepcopy N/A srcItem N/A key N/A updated True N/A updated N/A N/A N/A N/A self save newItem triggerEvents False N/A N/A N/A events trigger model.item.copy.prepare N/A srcItem newItem N/A file N/A N/A self childFiles item srcItem N/A N/A N/A N/A N/A N/A self model file copyFile file creator creator item newItem N/A newItem N/A N/A self load N/A newItem N/A _id force True N/A N/A N/A events trigger model.item.copy.after newItem N/A newItem N/A fileList N/A N/A self doc user path includeMetadata subpath N/A None False True N/A N/A 
        Generate a list of files within this item.

        :param doc: The item to list.
        :param user: A user used to validate data that is returned.  This isn't
                     used, but is present to be consistent across all model
                     implementations of fileList.
        :param path: A path prefix to add to the results.
        :type path: str
        :param includeMetadata: If True and there is any metadata, include a
                                result which is the JSON string of the
                                metadata.  This is given a name of
                                metadata[-(number).json that is distinct from
                                any file within the item.
        :type includeMetadata: bool
        :param subpath: If True and the item has more than one file, any
                        metadata, or the sole file is not named the same as the
                        item, then the returned paths include the item name.
        :type subpath: bool
        :returns: Iterable over files in this item, where each element is a
                  tuple of (path name of the file, stream function with file
                  data).
        :rtype: generator(str, func)
         N/A subpath N/A N/A files N/A list N/A N/A self childFiles item doc limit 2 N/A N/A N/A N/A len files 1 N/A N/A N/A files N/A 0 N/A name N/A doc N/A name N/A includeMetadata N/A N/A doc get meta N/A N/A N/A path N/A N/A N/A os path join path N/A doc N/A name N/A metadataFile girder-item-metadata.json N/A file N/A N/A self childFiles item doc N/A N/A N/A N/A file N/A name metadataFile N/A N/A metadataFile None N/A N/A N/A N/A N/A N/A os path join path N/A file N/A name N/A N/A N/A N/A self model file download file headers False N/A N/A includeMetadata metadataFile N/A len N/A N/A doc get meta N/A N/A stream N/A N/A N/A N/A N/A N/A N/A N/A json dumps N/A doc N/A meta default str N/A N/A N/A N/A N/A N/A N/A os path join path metadataFile stream N/A checkConsistency N/A N/A self stage progress N/A None N/A N/A 
        Check all of the items and make sure they are valid.  This operates in
        stages, since some actions should be done before other models that rely
        on items and some need to be done after.  The stages are:
        * count - count how many items need to be checked.
        * remove - remove lost items
        * verify - verify and fix existing items

        :param stage: which stage of the check to run.  See above.
        :param progress: an optional progress context to update.
        :returns: numItems: number of items to check or processed,
                  numChanged: number of items changed.
         N/A N/A stage count N/A N/A numItems N/A N/A N/A N/A self find limit 1 count N/A N/A numItems 0 N/A N/A N/A stage remove N/A N/A folderIds N/A N/A N/A N/A N/A self model folder collection distinct _id N/A lostItems N/A N/A self find N/A $or N/A N/A folderId N/A $nin folderIds N/A folderId N/A $exists False N/A numItems itemsLeft N/A N/A lostItems count N/A numItems N/A N/A N/A progress None N/A N/A N/A N/A progress update message Removing orphaned items N/A item lostItems N/A N/A N/A setResponseTimeLimit N/A N/A N/A N/A self collection delete_one N/A _id N/A item N/A _id N/A N/A progress None N/A N/A itemsLeft 1 N/A N/A N/A progress update increment 1 message N/A Removing orphaned items (%d left) itemsLeft N/A N/A numItems numItems N/A N/A N/A stage verify N/A N/A items N/A N/A self find N/A numItems itemsLeft N/A N/A items count N/A itemsCorrected 0 N/A N/A progress None N/A N/A N/A N/A progress update message Checking items N/A item items N/A N/A itemCorrected False N/A N/A setResponseTimeLimit N/A oldSize N/A N/A item get size 0 N/A newSize N/A N/A self recalculateSize item N/A N/A newSize oldSize N/A N/A itemCorrected True N/A newBaseParent N/A N/A N/A self parentsToRoot item force True N/A 0 N/A N/A N/A N/A item N/A baseParentType N/A newBaseParent N/A type N/A N/A item N/A baseParentId N/A N/A newBaseParent N/A object N/A _id N/A N/A N/A N/A self update N/A _id N/A item N/A _id update N/A $set N/A baseParentType baseParentId N/A newBaseParent N/A type N/A N/A newBaseParent N/A object N/A _id N/A itemCorrected True N/A itemCorrected N/A N/A itemsCorrected 1 N/A N/A progress None N/A N/A itemsLeft 1 N/A N/A N/A progress update increment 1 message N/A Checking items (%d left) itemsLeft N/A N/A numItems itemsCorrected N/A N/A