caoscrawler package

Subpackages

• caoscrawler.converters package
  • Submodules
    • caoscrawler.converters.converters module
      • BooleanElementConverter
      • CSVTableConverter
      • Converter
      • ConverterValidationError
      • CrawlerTemplate
      • DateElementConverter
      • DatetimeElementConverter
      • DictBooleanElementConverter
      • DictConverter
      • DictDictElementConverter
      • DictElementConverter
      • DictFloatElementConverter
      • DictIntegerElementConverter
      • DictListElementConverter
      • DictTextElementConverter
      • DirectoryConverter
      • FileConverter
      • FloatElementConverter
      • IntegerElementConverter
      • JSONFileConverter
      • ListElementConverter
      • MarkdownFileConverter
      • PropertiesFromDictConverter
      • SimpleFileConverter
      • TableConverter
      • TextElementConverter
      • XLSXTableConverter
      • YAMLFileConverter
      • convert_basic_element()
      • create_path_value()
      • create_records()
      • handle_value()
      • match_name_and_value()
      • replace_variables()
      • str_to_bool()
      • validate_against_json_schema()
    • caoscrawler.converters.hdf5_converter module
      • H5DatasetConverter
      • H5DatasetElement
      • H5FileConverter
      • H5GroupConverter
      • H5GroupElement
      • H5NdarrayConverter
      • H5NdarrayElement
      • convert_attributes()
      • convert_basic_element_with_nd_array()
      • convert_h5_element()
    • caoscrawler.converters.rocrate module
      • ELNFileConverter
      • ROCrateConverter
      • ROCrateEntityConverter
    • caoscrawler.converters.spss module
      • Configuration
      • SPSSConverter
      • read_column_types()
      • spss_to_datamodel_main()
      • spss_to_yaml()
    • caoscrawler.converters.transformer_converters module
      • SplitTextConverter
      • TransformTextConverter
    • caoscrawler.converters.xml_converter module
      • XMLAttributeNodeConverter
      • XMLFileConverter
      • XMLTagConverter
      • XMLTextNodeConverter
    • caoscrawler.converters.zipfile_converter module
      • ZipFileConverter
  • Module contents
• caoscrawler.macros package
  • Submodules
    • caoscrawler.macros.macro_yaml_object module
      • MacroDefinition
      • defmacro_constructor()
      • macro_constructor()
      • substitute()
      • substitute_dict()
  • Module contents
• caoscrawler.scripts package
  • Submodules
    • caoscrawler.scripts.generators module
      • csv_to_datamodel()
      • csv_to_datamodel_main()
  • Module contents
• caoscrawler.structure_elements package
  • Submodules
    • caoscrawler.structure_elements.rocrate_structure_elements module
      • ROCrateEntity
    • caoscrawler.structure_elements.structure_elements module
      • BooleanElement
      • Dict
      • DictBooleanElement
      • DictDictElement
      • DictElement
      • DictFloatElement
      • DictIntegerElement
      • DictListElement
      • DictTextElement
      • Directory
      • File
      • FileSystemStructureElement
      • FloatElement
      • IntegerElement
      • JSONFile
      • ListElement
      • NoneElement
      • StructureElement
      • TextElement
      • XMLAttributeNode
      • XMLTagElement
      • XMLTextNode
  • Module contents
• caoscrawler.transformers package
  • Submodules
    • caoscrawler.transformers.cast_and_parse_transformers module
      • cast_to_bool()
      • cast_to_float()
      • cast_to_int()
      • cast_to_str()
      • date_parse()
      • datetime_parse()
      • force_to_bool()
    • caoscrawler.transformers.string_transformers module
      • lower()
      • regex_replace()
      • removeprefix()
      • removesuffix()
      • replace()
      • split()
      • strip()
      • upper()
    • caoscrawler.transformers.substitution_transformers module
      • contentless_list_to_none()
      • submatch()
      • substitute_on_match()
      • substitute_with_dict()
  • Module contents

Submodules

• caoscrawler.authorize module
  • parse_args()
• caoscrawler.config module
  • get_config_setting()
• caoscrawler.crawl module
  • Crawler
    • Crawler.check_whether_parent_exists()
    • Crawler.compact_entity_list_representation()
    • Crawler.crawl_directory()
    • Crawler.crawled_data
    • Crawler.create_entity_summary()
    • Crawler.debug_build_usage_tree()
    • Crawler.execute_inserts_in_list()
    • Crawler.execute_parent_updates_in_list()
    • Crawler.execute_updates_in_list()
    • Crawler.generate_run_id()
    • Crawler.inform_about_pending_changes()
    • Crawler.initialize_converters()
    • Crawler.load_converters()
    • Crawler.load_definition()
    • Crawler.remove_unnecessary_updates()
    • Crawler.replace_entities_with_ids()
    • Crawler.replace_name_with_referenced_entity_id()
    • Crawler.save_debug_data()
    • Crawler.set_ids_and_datatype_of_parents_and_properties()
    • Crawler.start_crawling()
    • Crawler.synchronize()
  • ForbiddenTransaction
  • SecurityMode
    • SecurityMode.INSERT
    • SecurityMode.RETRIEVE
    • SecurityMode.UPDATE
  • check_identical()
  • crawler_main()
  • main()
  • parse_args()
  • split_restricted_path()
• caoscrawler.debug_tree module
  • DebugTree
• caoscrawler.exceptions module
  • ForbiddenTransaction
  • ImpossibleMergeError
    • ImpossibleMergeError.message
    • ImpossibleMergeError.values
    • ImpossibleMergeError.pname
  • InvalidIdentifiableYAML
  • MissingIdentifyingProperty
  • MissingRecordType
  • MissingReferencingEntityError
• caoscrawler.identifiable module
  • Identifiable
    • Identifiable.get_representation()
• caoscrawler.identifiable_adapters module
  • CaosDBIdentifiableAdapter
    • CaosDBIdentifiableAdapter.get_file()
    • CaosDBIdentifiableAdapter.get_registered_identifiable()
    • CaosDBIdentifiableAdapter.load_from_yaml_definition()
    • CaosDBIdentifiableAdapter.load_from_yaml_object()
    • CaosDBIdentifiableAdapter.register_identifiable()
    • CaosDBIdentifiableAdapter.retrieve_identified_record_for_identifiable()
  • IdentifiableAdapter
    • IdentifiableAdapter.all_identifying_properties_exist()
    • IdentifiableAdapter.create_property_query()
    • IdentifiableAdapter.create_query_for_identifiable()
    • IdentifiableAdapter.get_file()
    • IdentifiableAdapter.get_identifiable()
    • IdentifiableAdapter.get_identifying_referenced_entities()
    • IdentifiableAdapter.get_registered_identifiable()
    • IdentifiableAdapter.referencing_entity_has_appropriate_type()
    • IdentifiableAdapter.retrieve_identified_record_for_identifiable()
  • LocalStorageIdentifiableAdapter
    • LocalStorageIdentifiableAdapter.check_record()
    • LocalStorageIdentifiableAdapter.get_file()
    • LocalStorageIdentifiableAdapter.get_records()
    • LocalStorageIdentifiableAdapter.get_registered_identifiable()
    • LocalStorageIdentifiableAdapter.is_identifiable_for_record()
    • LocalStorageIdentifiableAdapter.register_identifiable()
    • LocalStorageIdentifiableAdapter.restore_state()
    • LocalStorageIdentifiableAdapter.retrieve_identified_record_for_identifiable()
    • LocalStorageIdentifiableAdapter.store_state()
  • convert_value()
  • get_children_of_rt()
• caoscrawler.logging module
  • configure_server_side_logging()
• caoscrawler.scanner module
  • create_converter_registry()
  • create_transformer_registry()
  • initialize_converters()
  • load_definition()
  • scan_directory()
  • scan_structure_elements()
  • scanner()
• caoscrawler.stores module
  • GeneralStore
  • RecordStore
    • RecordStore.get_names_current_scope()
    • RecordStore.get_records_current_scope()
  • Store
    • Store.create_scoped_copy()
    • Store.get_dict_copied()
    • Store.get_internal_id()
    • Store.get_storage()
    • Store.update()
• caoscrawler.sync_graph module
  • SyncGraph
    • SyncGraph.export_record_lists()
    • SyncGraph.get_equivalent()
    • SyncGraph.handle_negative_ids()
    • SyncGraph.set_id_of_node()
    • SyncGraph.unchecked_contains_circular_dependency()
• caoscrawler.sync_node module
  • SyncNode
    • SyncNode.export_entity()
    • SyncNode.update()
  • TempID
  • parent_in_list()
  • property_in_list()
• caoscrawler.transformer_functions module
• caoscrawler.utils module
  • MissingImport()
  • get_by_name_and_role()
  • get_shared_resource_link()
  • has_parent()
• caoscrawler.validator module
  • convert_record()
  • load_json_schema_from_datamodel_yaml()
  • representer_ordereddict()
  • validate()
• caoscrawler.version module
  • CfoodRequiredVersionError
  • check_cfood_version()
  • get_caoscrawler_version()

Module contents