baton 1.0.1

设置

要使用irods api，必须首先定义到irods的“连接” 服务器：

frombaton.apiimportconnect_to_irods_with_baton,Connection# Setup connection to iRODS using batonirods=connect_to_irods_with_baton("/where/baton/binaries/are/installed/",skip_baton_binaries_validation=False)# type: Connection

数据对象和集合

api提供了检索数据对象模型和 存储在irods服务器上的集合。类似于接力棒的json 提供，模型不包含有效载荷。但他们确实 提供对指挥棒可以检索的所有信息的访问 实体，包括访问控制列表（acl）、自定义元数据 （avus），数据对象的集合内容和信息 复制品。所有方法都提供不加载AVU的选项。

frombaton.modelsimportDataObject,Collection,SearchCriterion,ComparisonOperator# Get models of data objects or collections at the given path(s) in iRODSirods.data_object.get_by_path("/collection/data_object",load_metadata=False)# type: DataObject:irods.collection.get_by_path(["/collection","/other_collection"])# type: Sequence[Collection]:# Setup search for data objects or collections based on their metadatasearch_criterion_1=SearchCriterion("attribute","match_value",ComparisonOperator.EQUALS)search_criterion_2=SearchCriterion("other_attribute","other_match_value",ComparisonOperator.LESS_THAN)# Do search to get models of data objects or collectionsirods.data_object.get_by_metadata(search_criterion_1,zone="OptionalZoneRestriction")# type: Sequence[DataObject]irods.collection.get_by_metadata([search_criterion_1,search_criterion_2],load_metadata=False)# type: Sequence[Collection]# Get models of data objects or collections contained within a collection(s)irods.collection.get_all_in_collection("/collection",load_metadata=False)# type: Sequence[Collection]irods.data_object.get_all_in_collection(["/collection","/other_collection"])# type: Sequence[DataObject]

元数据（AVU）

api提供了检索和操作自定义 与数据对象和集合关联的元数据（AVU）。

警告：当前不支持读取/写入单元 AVUS的财产。

尽管数据对象和 收集，由于irods的工作方式，有必要知道 路径对应的实体类型，以便检索元数据。

frombaton.collectionsimportIrodsMetadatametadata_1=IrodsMetadata({"key":{"value_1"}})metadata_2=IrodsMetadata({"another_key":{"value_1","value_2"}})# Metadata (methods available for both `data_object` and `collection`)irods.data_object.metadata.get_all("/collection/data_object")# type: IrodsMetadatairods.collection.metadata.get_all(["/collection","/other_collection"])# type: Sequence[IrodsMetadata]# `metadata_1` is added to the data object with the first path in the list and `metadata_2` is added to the secondirods.data_object.metadata.add(["/collection/data_object","/other_data_object"],[metadata_1,metadata_2])irods.collection.metadata.add("/collection",metadata_1)irods.data_object.metadata.set("/collection/data_object",metadata_1)# `metadata_1` is added to both collections in the listirods.collection.metadata.set(["/collection","/other_collection"],metadata_1)irods.data_object.metadata.remove(["/collection/data_object","/other_data_object"],[metadata_1,metadata_2])irods.collection.metadata.remove("/collection",metadata_1)irods.data_object.metadata.remove_all("/collection/data_object")irods.collection.metadata.remove_all(["/collection","/other_collection"])

访问控制列表（ACL）

api提供了检索和操作访问的能力 与数据对象和集合关联的控制列表（ACL）。

frombaton.modelsimportAccessControl# ACLs. Note: it is implied that the owner is in the same zone as the entity to which the access control is appliedacl_examples=[AccessControl(User("user_1","zone_user_is_in"),AccessControl.Level.READ),AccessControl(User("group_1","zone_group_is_in"),AccessControl.Level.WRITE),AccessControl("user_1#zone_user_is_in",AccessControl.Level.OWN)]irods.data_object.access_control.get_all("/collection/data_object")# type: Set[AccessControl]irods.collection.access_control.get_all(["/collection","/another/collection"])# type: List[Set[AccessControl]]irods.data_object.access_control.add_or_replace(["/collection/data_object","/another/data_object"],acl_examples[0])irods.collection.access_control.add_or_replace("/collection",acl_examples,recursive=True)irods.data_object.access_control.set("/collection/data_object",acl_examples[1])irods.collection.access_control.set(["/collection","/another/collection"],acl_examples[0],recursive=False)irods.data_object.access_control.revoke(["/collection/data_object","/another/data_object"],acl_examples)irods.collection.access_control.revoke("/collection",acl_examples[1],recursive=True)irods.data_object.access_control.revoke_all(["/collection/data_object","/another/data_object"])irods.collection.access_control.revoke_all("/collection",recursive=True)

通过特定查询自定义对象

irods支持返回新类型对象的特定查询。在 为了通过这个库在irods中使用这些自定义对象， 应制作物体模型。那么，一个子类 BatonCustomObjectMapper需要定义以指定 可以使用特定查询（或特定查询的数量）来检索 从和/或修改irods中的对象。

api提供检索已安装的查询的能力 在irods服务器上（具有讽刺意味的是，通过使用特定的查询！）：

frombaton.modelsimportSpecificQuery# Get specific queries that have been installed on the iRODS serverirods.specific_query.get_all(zone="OptionalZoneRestriction")# type: Sequence[SpecificQuery]

json序列化/反序列化

几乎所有irods对象模型都有json编码器和解码器。 在这个图书馆里。这些可以用来把模型转换成指挥棒 定义的json表示。所有序列化程序/反序列化程序都扩展 JSONEncoder和JSONDecoder（大多数通过使用 hgijson库）含义 它们可以与python内置的json一起使用 包装<；https://docs.python.org/3/library/json.html>；`` uu:

importjsonfrombaton.jsonimportDataObjectJSONEncoder,DataObjectJSONDecoder,CollectionJSONEncoder,CollectionJSONDecoder,IrodsMetadataJSONEncoder,IrodsMetadataJSONDecoder,AccessControlJSONEncoder,AccessControlJSONDecoderdata_object_as_json_string=json.dumps(data_object,cls=DataObjectJSONEncoder)# type: strdata_object=json.loads(data_object_as_json_string,cls=DataObjectJSONDecoder)# type: DataObjectcollection_as_json_string=json.dumps(collection,cls=CollectionJSONEncoder)# type: strcollection=json.loads(collection_as_json_string,cls=CollectionJSONDecoder)# type: Collectionmetadata_as_json_string=json.dumps(metadata,cls=IrodsMetadataJSONEncoder)# type: strmetadata=json.loads(metadata_as_json_string,cls=IrodsMetadataJSONDecoder)# type: IrodsMetadataacl_as_json_string=json.dumps(metadata,cls=AccessControlJSONEncoder)# type: stracl=json.loads(acl_as_json_string,cls=AccessControlJSONDecoder)# type: List[AccessControl]