Skip to main content
Ctrl+K

CAF.base 0.4.1

  • Quick Start
  • User Guide
  • API Reference
  • Changelog
    • Issues
    • CAF Handbook
  • GitHub
  • Quick Start
  • User Guide
  • API Reference
  • Changelog
  • Issues
  • CAF Handbook
  • GitHub

Section Navigation

  • caf.base
    • BalancingZones
      • BalancingZones.__init__
      • BalancingZones.get_zoning
      • BalancingZones.load
      • BalancingZones.save
      • BalancingZones.zoning_groups
    • DVector
      • DVector.__init__
      • DVector.add_segments
      • DVector.add_value_to_subset
      • DVector.aggregate
      • DVector.aggregate_comp_zones
      • DVector.balance_by_segments
      • DVector.calc_rmse
      • DVector.combine_from_dic
      • DVector.composite_zoning
      • DVector.concat
      • DVector.concat_from_dir
      • DVector.concat_list
      • DVector.concat_to_comp_zoning
      • DVector.copy
      • DVector.drop_by_segment_values
      • DVector.expand_to_other
      • DVector.fill
      • DVector.fillna
      • DVector.filter_segment_value
      • DVector.get_slice
      • DVector.ipf
      • DVector.load
      • DVector.old_to_new_dvec
      • DVector.overlap
      • DVector.remove_zoning
      • DVector.rename_segment
      • DVector.save
      • DVector.select_zone
      • DVector.split_by_agg_zoning
      • DVector.split_by_other
      • DVector.sum
      • DVector.sum_is_close
      • DVector.sum_zoning
      • DVector.to_ie
      • DVector.trans_and_comp
      • DVector.trans_seg_from_lookup
      • DVector.translate_segment
      • DVector.translate_zoning
      • DVector.validate_ipf_targets
      • DVector.write_sector_reports
    • Segment
      • Segment.__init__
      • Segment.add_corr_from_df
      • Segment.construct
      • Segment.copy
      • Segment.dict
      • Segment.drop_indices
      • Segment.extract_values
      • Segment.from_orm
      • Segment.from_yaml
      • Segment.get_alias
      • Segment.get_value_alias
      • Segment.json
      • Segment.load_yaml
      • Segment.lookup_indices
      • Segment.model_construct
      • Segment.model_copy
      • Segment.model_dump
      • Segment.model_dump_json
      • Segment.model_json_schema
      • Segment.model_parametrized_name
      • Segment.model_post_init
      • Segment.model_rebuild
      • Segment.model_validate
      • Segment.model_validate_json
      • Segment.model_validate_strings
      • Segment.parse_file
      • Segment.parse_obj
      • Segment.parse_raw
      • Segment.save_yaml
      • Segment.schema
      • Segment.schema_json
      • Segment.to_yaml
      • Segment.translate_exclusion
      • Segment.translate_segment
      • Segment.update_forward_refs
      • Segment.validate
      • Segment.value_regex
      • Segment.write_example
    • Segmentation
      • Segmentation.__init__
      • Segmentation.add_segment
      • Segmentation.aggregate
      • Segmentation.convert_slice_name
      • Segmentation.convert_slice_tuple
      • Segmentation.copy
      • Segmentation.find_files
      • Segmentation.generate_slice_name
      • Segmentation.get_segment
      • Segmentation.get_segment_values
      • Segmentation.has_time_period_segments
      • Segmentation.ind
      • Segmentation.is_subset
      • Segmentation.iter_slices
      • Segmentation.load
      • Segmentation.lookup_ind
      • Segmentation.overlap
      • Segmentation.reinit
      • Segmentation.remove_segment
      • Segmentation.save
      • Segmentation.subset_difference
      • Segmentation.translate_segment
      • Segmentation.update_subsets
      • Segmentation.validate_segmentation
      • Segmentation.validate_slice
    • SegmentationInput
      • SegmentationInput.__init__
      • SegmentationInput.construct
      • SegmentationInput.copy
      • SegmentationInput.dict
      • SegmentationInput.enums
      • SegmentationInput.from_orm
      • SegmentationInput.from_yaml
      • SegmentationInput.json
      • SegmentationInput.load_yaml
      • SegmentationInput.model_construct
      • SegmentationInput.model_copy
      • SegmentationInput.model_dump
      • SegmentationInput.model_dump_json
      • SegmentationInput.model_json_schema
      • SegmentationInput.model_parametrized_name
      • SegmentationInput.model_post_init
      • SegmentationInput.model_rebuild
      • SegmentationInput.model_validate
      • SegmentationInput.model_validate_json
      • SegmentationInput.model_validate_strings
      • SegmentationInput.names_match_segments
      • SegmentationInput.no_copied_names
      • SegmentationInput.parse_file
      • SegmentationInput.parse_obj
      • SegmentationInput.parse_raw
      • SegmentationInput.save_yaml
      • SegmentationInput.schema
      • SegmentationInput.schema_json
      • SegmentationInput.to_yaml
      • SegmentationInput.update_forward_refs
      • SegmentationInput.validate
      • SegmentationInput.write_example
    • ZoningSystem
      • ZoningSystem.__init__
      • ZoningSystem.check_all_columns
      • ZoningSystem.copy
      • ZoningSystem.external
      • ZoningSystem.get_inverse_subset
      • ZoningSystem.get_subset
      • ZoningSystem.get_zoning
      • ZoningSystem.internal
      • ZoningSystem.load
      • ZoningSystem.old_to_new_zoning
      • ZoningSystem.save
      • ZoningSystem.trans_df_to_dict
      • ZoningSystem.translate
      • ZoningSystem.translation_column_name
      • ZoningSystem.validate_translation_data
      • ZoningSystem.zone_descriptions
      • ZoningSystem.zone_names
      • ZoningSystem.zoning_from_df_col
      • ZoningSystem.zoning_from_shapefile
    • caf.base.data_structures
      • deepcopy
      • listdir
      • normalise_column_name
      • BalancingZones
        • BalancingZones.__init__
        • BalancingZones.get_zoning
        • BalancingZones.load
        • BalancingZones.save
        • BalancingZones.zoning_groups
      • Collection
        • Collection.__init__
      • DVector
        • DVector.__init__
        • DVector.add_segments
        • DVector.add_value_to_subset
        • DVector.aggregate
        • DVector.aggregate_comp_zones
        • DVector.balance_by_segments
        • DVector.calc_rmse
        • DVector.combine_from_dic
        • DVector.composite_zoning
        • DVector.concat
        • DVector.concat_from_dir
        • DVector.concat_list
        • DVector.concat_to_comp_zoning
        • DVector.copy
        • DVector.drop_by_segment_values
        • DVector.expand_to_other
        • DVector.fill
        • DVector.fillna
        • DVector.filter_segment_value
        • DVector.get_slice
        • DVector.ipf
        • DVector.load
        • DVector.old_to_new_dvec
        • DVector.overlap
        • DVector.remove_zoning
        • DVector.rename_segment
        • DVector.save
        • DVector.select_zone
        • DVector.split_by_agg_zoning
        • DVector.split_by_other
        • DVector.sum
        • DVector.sum_is_close
        • DVector.sum_zoning
        • DVector.to_ie
        • DVector.trans_and_comp
        • DVector.trans_seg_from_lookup
        • DVector.translate_segment
        • DVector.translate_zoning
        • DVector.validate_ipf_targets
        • DVector.write_sector_reports
      • IpfTarget
        • IpfTarget.__init__
        • IpfTarget.check_compatibility
        • IpfTarget.singly_zoned
      • Number
        • Number.__init__
      • Path
        • Path.__init__
        • Path.absolute
        • Path.as_posix
        • Path.as_uri
        • Path.chmod
        • Path.cwd
        • Path.exists
        • Path.expanduser
        • Path.glob
        • Path.group
        • Path.hardlink_to
        • Path.home
        • Path.is_absolute
        • Path.is_block_device
        • Path.is_char_device
        • Path.is_dir
        • Path.is_fifo
        • Path.is_file
        • Path.is_mount
        • Path.is_relative_to
        • Path.is_reserved
        • Path.is_socket
        • Path.is_symlink
        • Path.iterdir
        • Path.joinpath
        • Path.lchmod
        • Path.link_to
        • Path.lstat
        • Path.match
        • Path.mkdir
        • Path.open
        • Path.owner
        • Path.read_bytes
        • Path.read_text
        • Path.readlink
        • Path.relative_to
        • Path.rename
        • Path.replace
        • Path.resolve
        • Path.rglob
        • Path.rmdir
        • Path.samefile
        • Path.stat
        • Path.symlink_to
        • Path.touch
        • Path.unlink
        • Path.with_name
        • Path.with_stem
        • Path.with_suffix
        • Path.write_bytes
        • Path.write_text
      • PathLike
        • PathLike.__init__
      • SegConverter
        • SegConverter.get_conversion
      • Segment
        • Segment.__init__
        • Segment.add_corr_from_df
        • Segment.construct
        • Segment.copy
        • Segment.dict
        • Segment.drop_indices
        • Segment.extract_values
        • Segment.from_orm
        • Segment.from_yaml
        • Segment.get_alias
        • Segment.get_value_alias
        • Segment.json
        • Segment.load_yaml
        • Segment.lookup_indices
        • Segment.model_construct
        • Segment.model_copy
        • Segment.model_dump
        • Segment.model_dump_json
        • Segment.model_json_schema
        • Segment.model_parametrized_name
        • Segment.model_post_init
        • Segment.model_rebuild
        • Segment.model_validate
        • Segment.model_validate_json
        • Segment.model_validate_strings
        • Segment.parse_file
        • Segment.parse_obj
        • Segment.parse_raw
        • Segment.save_yaml
        • Segment.schema
        • Segment.schema_json
        • Segment.to_yaml
        • Segment.translate_exclusion
        • Segment.translate_segment
        • Segment.update_forward_refs
        • Segment.validate
        • Segment.value_regex
        • Segment.write_example
      • Segmentation
        • Segmentation.__init__
        • Segmentation.add_segment
        • Segmentation.aggregate
        • Segmentation.convert_slice_name
        • Segmentation.convert_slice_tuple
        • Segmentation.copy
        • Segmentation.find_files
        • Segmentation.generate_slice_name
        • Segmentation.get_segment
        • Segmentation.get_segment_values
        • Segmentation.has_time_period_segments
        • Segmentation.ind
        • Segmentation.is_subset
        • Segmentation.iter_slices
        • Segmentation.load
        • Segmentation.lookup_ind
        • Segmentation.overlap
        • Segmentation.reinit
        • Segmentation.remove_segment
        • Segmentation.save
        • Segmentation.subset_difference
        • Segmentation.translate_segment
        • Segmentation.update_subsets
        • Segmentation.validate_segmentation
        • Segmentation.validate_slice
      • SegmentationSlice
        • SegmentationSlice.__init__
        • SegmentationSlice.add
        • SegmentationSlice.as_tuple
        • SegmentationSlice.from_tuple
        • SegmentationSlice.generate_name
        • SegmentationSlice.get
        • SegmentationSlice.remove
        • SegmentationSlice.replace
      • SegmentsSuper
        • SegmentsSuper.values
        • SegmentsSuper.get_segment
      • TimeFormat
        • TimeFormat.get_time_periods
        • TimeFormat.conversion_order
        • TimeFormat.avg_hour_to_total_hour_factors
        • TimeFormat.total_hour_to_avg_hour_factors
        • TimeFormat.get
        • TimeFormat.get_conversion_factors
      • TranslationWeighting
        • TranslationWeighting.get_suffix
      • ZoningSystem
        • ZoningSystem.__init__
        • ZoningSystem.check_all_columns
        • ZoningSystem.copy
        • ZoningSystem.external
        • ZoningSystem.get_inverse_subset
        • ZoningSystem.get_subset
        • ZoningSystem.get_zoning
        • ZoningSystem.internal
        • ZoningSystem.load
        • ZoningSystem.old_to_new_zoning
        • ZoningSystem.save
        • ZoningSystem.trans_df_to_dict
        • ZoningSystem.translate
        • ZoningSystem.translation_column_name
        • ZoningSystem.validate_translation_data
        • ZoningSystem.zone_descriptions
        • ZoningSystem.zone_names
        • ZoningSystem.zoning_from_df_col
        • ZoningSystem.zoning_from_shapefile
      • ZoningSystemMetaData
        • ZoningSystemMetaData.__init__
        • ZoningSystemMetaData.construct
        • ZoningSystemMetaData.copy
        • ZoningSystemMetaData.dict
        • ZoningSystemMetaData.from_orm
        • ZoningSystemMetaData.from_yaml
        • ZoningSystemMetaData.json
        • ZoningSystemMetaData.load_yaml
        • ZoningSystemMetaData.model_construct
        • ZoningSystemMetaData.model_copy
        • ZoningSystemMetaData.model_dump
        • ZoningSystemMetaData.model_dump_json
        • ZoningSystemMetaData.model_json_schema
        • ZoningSystemMetaData.model_parametrized_name
        • ZoningSystemMetaData.model_post_init
        • ZoningSystemMetaData.model_rebuild
        • ZoningSystemMetaData.model_validate
        • ZoningSystemMetaData.model_validate_json
        • ZoningSystemMetaData.model_validate_strings
        • ZoningSystemMetaData.parse_file
        • ZoningSystemMetaData.parse_obj
        • ZoningSystemMetaData.parse_raw
        • ZoningSystemMetaData.save_yaml
        • ZoningSystemMetaData.schema
        • ZoningSystemMetaData.schema_json
        • ZoningSystemMetaData.to_yaml
        • ZoningSystemMetaData.update_forward_refs
        • ZoningSystemMetaData.validate
        • ZoningSystemMetaData.write_example
      • SegmentationError
      • SegmentationWarning
      • TranslationError
      • ZoningError
    • caf.base.segmentation
      • NamedTuple
      • ordered_set
      • product_multiindex
      • BaseConfig
        • BaseConfig.__init__
        • BaseConfig.construct
        • BaseConfig.copy
        • BaseConfig.dict
        • BaseConfig.from_orm
        • BaseConfig.from_yaml
        • BaseConfig.json
        • BaseConfig.load_yaml
        • BaseConfig.model_construct
        • BaseConfig.model_copy
        • BaseConfig.model_dump
        • BaseConfig.model_dump_json
        • BaseConfig.model_json_schema
        • BaseConfig.model_parametrized_name
        • BaseConfig.model_post_init
        • BaseConfig.model_rebuild
        • BaseConfig.model_validate
        • BaseConfig.model_validate_json
        • BaseConfig.model_validate_strings
        • BaseConfig.parse_file
        • BaseConfig.parse_obj
        • BaseConfig.parse_raw
        • BaseConfig.save_yaml
        • BaseConfig.schema
        • BaseConfig.schema_json
        • BaseConfig.to_yaml
        • BaseConfig.update_forward_refs
        • BaseConfig.validate
        • BaseConfig.write_example
      • Path
        • Path.__init__
        • Path.absolute
        • Path.as_posix
        • Path.as_uri
        • Path.chmod
        • Path.cwd
        • Path.exists
        • Path.expanduser
        • Path.glob
        • Path.group
        • Path.hardlink_to
        • Path.home
        • Path.is_absolute
        • Path.is_block_device
        • Path.is_char_device
        • Path.is_dir
        • Path.is_fifo
        • Path.is_file
        • Path.is_mount
        • Path.is_relative_to
        • Path.is_reserved
        • Path.is_socket
        • Path.is_symlink
        • Path.iterdir
        • Path.joinpath
        • Path.lchmod
        • Path.link_to
        • Path.lstat
        • Path.match
        • Path.mkdir
        • Path.open
        • Path.owner
        • Path.read_bytes
        • Path.read_text
        • Path.readlink
        • Path.relative_to
        • Path.rename
        • Path.replace
        • Path.resolve
        • Path.rglob
        • Path.rmdir
        • Path.samefile
        • Path.stat
        • Path.symlink_to
        • Path.touch
        • Path.unlink
        • Path.with_name
        • Path.with_stem
        • Path.with_suffix
        • Path.write_bytes
        • Path.write_text
      • PathLike
        • PathLike.__init__
      • Segment
        • Segment.__init__
        • Segment.add_corr_from_df
        • Segment.construct
        • Segment.copy
        • Segment.dict
        • Segment.drop_indices
        • Segment.extract_values
        • Segment.from_orm
        • Segment.from_yaml
        • Segment.get_alias
        • Segment.get_value_alias
        • Segment.json
        • Segment.load_yaml
        • Segment.lookup_indices
        • Segment.model_construct
        • Segment.model_copy
        • Segment.model_dump
        • Segment.model_dump_json
        • Segment.model_json_schema
        • Segment.model_parametrized_name
        • Segment.model_post_init
        • Segment.model_rebuild
        • Segment.model_validate
        • Segment.model_validate_json
        • Segment.model_validate_strings
        • Segment.parse_file
        • Segment.parse_obj
        • Segment.parse_raw
        • Segment.save_yaml
        • Segment.schema
        • Segment.schema_json
        • Segment.to_yaml
        • Segment.translate_exclusion
        • Segment.translate_segment
        • Segment.update_forward_refs
        • Segment.validate
        • Segment.value_regex
        • Segment.write_example
      • Segmentation
        • Segmentation.__init__
        • Segmentation.add_segment
        • Segmentation.aggregate
        • Segmentation.convert_slice_name
        • Segmentation.convert_slice_tuple
        • Segmentation.copy
        • Segmentation.find_files
        • Segmentation.generate_slice_name
        • Segmentation.get_segment
        • Segmentation.get_segment_values
        • Segmentation.has_time_period_segments
        • Segmentation.ind
        • Segmentation.is_subset
        • Segmentation.iter_slices
        • Segmentation.load
        • Segmentation.lookup_ind
        • Segmentation.overlap
        • Segmentation.reinit
        • Segmentation.remove_segment
        • Segmentation.save
        • Segmentation.subset_difference
        • Segmentation.translate_segment
        • Segmentation.update_subsets
        • Segmentation.validate_segmentation
        • Segmentation.validate_slice
      • SegmentationInput
        • SegmentationInput.__init__
        • SegmentationInput.construct
        • SegmentationInput.copy
        • SegmentationInput.dict
        • SegmentationInput.enums
        • SegmentationInput.from_orm
        • SegmentationInput.from_yaml
        • SegmentationInput.json
        • SegmentationInput.load_yaml
        • SegmentationInput.model_construct
        • SegmentationInput.model_copy
        • SegmentationInput.model_dump
        • SegmentationInput.model_dump_json
        • SegmentationInput.model_json_schema
        • SegmentationInput.model_parametrized_name
        • SegmentationInput.model_post_init
        • SegmentationInput.model_rebuild
        • SegmentationInput.model_validate
        • SegmentationInput.model_validate_json
        • SegmentationInput.model_validate_strings
        • SegmentationInput.names_match_segments
        • SegmentationInput.no_copied_names
        • SegmentationInput.parse_file
        • SegmentationInput.parse_obj
        • SegmentationInput.parse_raw
        • SegmentationInput.save_yaml
        • SegmentationInput.schema
        • SegmentationInput.schema_json
        • SegmentationInput.to_yaml
        • SegmentationInput.update_forward_refs
        • SegmentationInput.validate
        • SegmentationInput.write_example
      • SegmentationSlice
        • SegmentationSlice.__init__
        • SegmentationSlice.add
        • SegmentationSlice.as_tuple
        • SegmentationSlice.from_tuple
        • SegmentationSlice.generate_name
        • SegmentationSlice.get
        • SegmentationSlice.remove
        • SegmentationSlice.replace
      • SegmentsSuper
        • SegmentsSuper.values
        • SegmentsSuper.get_segment
      • SegmentationError
      • SegmentationWarning
    • caf.base.segments
      • BaseConfig
        • BaseConfig.__init__
        • BaseConfig.construct
        • BaseConfig.copy
        • BaseConfig.dict
        • BaseConfig.from_orm
        • BaseConfig.from_yaml
        • BaseConfig.json
        • BaseConfig.load_yaml
        • BaseConfig.model_construct
        • BaseConfig.model_copy
        • BaseConfig.model_dump
        • BaseConfig.model_dump_json
        • BaseConfig.model_json_schema
        • BaseConfig.model_parametrized_name
        • BaseConfig.model_post_init
        • BaseConfig.model_rebuild
        • BaseConfig.model_validate
        • BaseConfig.model_validate_json
        • BaseConfig.model_validate_strings
        • BaseConfig.parse_file
        • BaseConfig.parse_obj
        • BaseConfig.parse_raw
        • BaseConfig.save_yaml
        • BaseConfig.schema
        • BaseConfig.schema_json
        • BaseConfig.to_yaml
        • BaseConfig.update_forward_refs
        • BaseConfig.validate
        • BaseConfig.write_example
      • ConfigDict
        • ConfigDict.__init__
        • ConfigDict.clear
        • ConfigDict.copy
        • ConfigDict.fromkeys
        • ConfigDict.get
        • ConfigDict.items
        • ConfigDict.keys
        • ConfigDict.pop
        • ConfigDict.popitem
        • ConfigDict.setdefault
        • ConfigDict.update
        • ConfigDict.values
      • Exclusion
        • Exclusion.__init__
        • Exclusion.build_index
      • Path
        • Path.__init__
        • Path.absolute
        • Path.as_posix
        • Path.as_uri
        • Path.chmod
        • Path.cwd
        • Path.exists
        • Path.expanduser
        • Path.glob
        • Path.group
        • Path.hardlink_to
        • Path.home
        • Path.is_absolute
        • Path.is_block_device
        • Path.is_char_device
        • Path.is_dir
        • Path.is_fifo
        • Path.is_file
        • Path.is_mount
        • Path.is_relative_to
        • Path.is_reserved
        • Path.is_socket
        • Path.is_symlink
        • Path.iterdir
        • Path.joinpath
        • Path.lchmod
        • Path.link_to
        • Path.lstat
        • Path.match
        • Path.mkdir
        • Path.open
        • Path.owner
        • Path.read_bytes
        • Path.read_text
        • Path.readlink
        • Path.relative_to
        • Path.rename
        • Path.replace
        • Path.resolve
        • Path.rglob
        • Path.rmdir
        • Path.samefile
        • Path.stat
        • Path.symlink_to
        • Path.touch
        • Path.unlink
        • Path.with_name
        • Path.with_stem
        • Path.with_suffix
        • Path.write_bytes
        • Path.write_text
      • SegConverter
        • SegConverter.get_conversion
      • Segment
        • Segment.__init__
        • Segment.add_corr_from_df
        • Segment.construct
        • Segment.copy
        • Segment.dict
        • Segment.drop_indices
        • Segment.extract_values
        • Segment.from_orm
        • Segment.from_yaml
        • Segment.get_alias
        • Segment.get_value_alias
        • Segment.json
        • Segment.load_yaml
        • Segment.lookup_indices
        • Segment.model_construct
        • Segment.model_copy
        • Segment.model_dump
        • Segment.model_dump_json
        • Segment.model_json_schema
        • Segment.model_parametrized_name
        • Segment.model_post_init
        • Segment.model_rebuild
        • Segment.model_validate
        • Segment.model_validate_json
        • Segment.model_validate_strings
        • Segment.parse_file
        • Segment.parse_obj
        • Segment.parse_raw
        • Segment.save_yaml
        • Segment.schema
        • Segment.schema_json
        • Segment.to_yaml
        • Segment.translate_exclusion
        • Segment.translate_segment
        • Segment.update_forward_refs
        • Segment.validate
        • Segment.value_regex
        • Segment.write_example
      • SegmentsSuper
        • SegmentsSuper.values
        • SegmentsSuper.get_segment
    • caf.base.zoning
      • normalise_column_name
      • Any
        • Any.__init__
      • BalancingZones
        • BalancingZones.__init__
        • BalancingZones.get_zoning
        • BalancingZones.load
        • BalancingZones.save
        • BalancingZones.zoning_groups
      • Path
        • Path.__init__
        • Path.absolute
        • Path.as_posix
        • Path.as_uri
        • Path.chmod
        • Path.cwd
        • Path.exists
        • Path.expanduser
        • Path.glob
        • Path.group
        • Path.hardlink_to
        • Path.home
        • Path.is_absolute
        • Path.is_block_device
        • Path.is_char_device
        • Path.is_dir
        • Path.is_fifo
        • Path.is_file
        • Path.is_mount
        • Path.is_relative_to
        • Path.is_reserved
        • Path.is_socket
        • Path.is_symlink
        • Path.iterdir
        • Path.joinpath
        • Path.lchmod
        • Path.link_to
        • Path.lstat
        • Path.match
        • Path.mkdir
        • Path.open
        • Path.owner
        • Path.read_bytes
        • Path.read_text
        • Path.readlink
        • Path.relative_to
        • Path.rename
        • Path.replace
        • Path.resolve
        • Path.rglob
        • Path.rmdir
        • Path.samefile
        • Path.stat
        • Path.symlink_to
        • Path.touch
        • Path.unlink
        • Path.with_name
        • Path.with_stem
        • Path.with_suffix
        • Path.write_bytes
        • Path.write_text
      • PathLike
        • PathLike.__init__
      • Segmentation
        • Segmentation.__init__
        • Segmentation.add_segment
        • Segmentation.aggregate
        • Segmentation.convert_slice_name
        • Segmentation.convert_slice_tuple
        • Segmentation.copy
        • Segmentation.find_files
        • Segmentation.generate_slice_name
        • Segmentation.get_segment
        • Segmentation.get_segment_values
        • Segmentation.has_time_period_segments
        • Segmentation.ind
        • Segmentation.is_subset
        • Segmentation.iter_slices
        • Segmentation.load
        • Segmentation.lookup_ind
        • Segmentation.overlap
        • Segmentation.reinit
        • Segmentation.remove_segment
        • Segmentation.save
        • Segmentation.subset_difference
        • Segmentation.translate_segment
        • Segmentation.update_subsets
        • Segmentation.validate_segmentation
        • Segmentation.validate_slice
      • SegmentationInput
        • SegmentationInput.__init__
        • SegmentationInput.construct
        • SegmentationInput.copy
        • SegmentationInput.dict
        • SegmentationInput.enums
        • SegmentationInput.from_orm
        • SegmentationInput.from_yaml
        • SegmentationInput.json
        • SegmentationInput.load_yaml
        • SegmentationInput.model_construct
        • SegmentationInput.model_copy
        • SegmentationInput.model_dump
        • SegmentationInput.model_dump_json
        • SegmentationInput.model_json_schema
        • SegmentationInput.model_parametrized_name
        • SegmentationInput.model_post_init
        • SegmentationInput.model_rebuild
        • SegmentationInput.model_validate
        • SegmentationInput.model_validate_json
        • SegmentationInput.model_validate_strings
        • SegmentationInput.names_match_segments
        • SegmentationInput.no_copied_names
        • SegmentationInput.parse_file
        • SegmentationInput.parse_obj
        • SegmentationInput.parse_raw
        • SegmentationInput.save_yaml
        • SegmentationInput.schema
        • SegmentationInput.schema_json
        • SegmentationInput.to_yaml
        • SegmentationInput.update_forward_refs
        • SegmentationInput.validate
        • SegmentationInput.write_example
      • TranslationWeighting
        • TranslationWeighting.get_suffix
      • ZoningSystem
        • ZoningSystem.__init__
        • ZoningSystem.check_all_columns
        • ZoningSystem.copy
        • ZoningSystem.external
        • ZoningSystem.get_inverse_subset
        • ZoningSystem.get_subset
        • ZoningSystem.get_zoning
        • ZoningSystem.internal
        • ZoningSystem.load
        • ZoningSystem.old_to_new_zoning
        • ZoningSystem.save
        • ZoningSystem.trans_df_to_dict
        • ZoningSystem.translate
        • ZoningSystem.translation_column_name
        • ZoningSystem.validate_translation_data
        • ZoningSystem.zone_descriptions
        • ZoningSystem.zone_names
        • ZoningSystem.zoning_from_df_col
        • ZoningSystem.zoning_from_shapefile
      • ZoningSystemMetaData
        • ZoningSystemMetaData.__init__
        • ZoningSystemMetaData.construct
        • ZoningSystemMetaData.copy
        • ZoningSystemMetaData.dict
        • ZoningSystemMetaData.from_orm
        • ZoningSystemMetaData.from_yaml
        • ZoningSystemMetaData.json
        • ZoningSystemMetaData.load_yaml
        • ZoningSystemMetaData.model_construct
        • ZoningSystemMetaData.model_copy
        • ZoningSystemMetaData.model_dump
        • ZoningSystemMetaData.model_dump_json
        • ZoningSystemMetaData.model_json_schema
        • ZoningSystemMetaData.model_parametrized_name
        • ZoningSystemMetaData.model_post_init
        • ZoningSystemMetaData.model_rebuild
        • ZoningSystemMetaData.model_validate
        • ZoningSystemMetaData.model_validate_json
        • ZoningSystemMetaData.model_validate_strings
        • ZoningSystemMetaData.parse_file
        • ZoningSystemMetaData.parse_obj
        • ZoningSystemMetaData.parse_raw
        • ZoningSystemMetaData.save_yaml
        • ZoningSystemMetaData.schema
        • ZoningSystemMetaData.schema_json
        • ZoningSystemMetaData.to_yaml
        • ZoningSystemMetaData.update_forward_refs
        • ZoningSystemMetaData.validate
        • ZoningSystemMetaData.write_example
      • PerformanceWarning
      • TranslationError
      • TranslationWarning
      • ZoningError

Indices

  • General Index
  • Python Module Index
  • API Reference
  • caf.base
  • caf.base.data_structures
  • Path
  • Path.readlink

Path.readlink#

Path.readlink()#

Return the path to which the symbolic link points.

previous

Path.read_text

next

Path.relative_to
On this page
  • Path.readlink()
Edit on GitHub

© Copyright 2025, Transport for the North.

Created using Sphinx 9.0.4.

Built with the PyData Sphinx Theme 0.17.1.