Skip to main content
Ctrl+K
The documentation pages are currently work-in-progress, if you have any suggestions for improvements please raise an issue on the caf.mat repository.

CAF.mat 0.0.1+125.ge087b07

  • 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.mat
    • caf.mat.cube
      • CUBEMatConverter
        • CUBEMatConverter.__init__
        • CUBEMatConverter.folder_to_omx
        • CUBEMatConverter.from_csv
        • CUBEMatConverter.from_omx
        • CUBEMatConverter.to_omx
      • Path
        • Path.absolute
        • Path.chmod
        • Path.cwd
        • Path.exists
        • Path.expanduser
        • Path.glob
        • Path.group
        • Path.hardlink_to
        • Path.home
        • Path.is_block_device
        • Path.is_char_device
        • Path.is_dir
        • Path.is_fifo
        • Path.is_file
        • Path.is_mount
        • Path.is_socket
        • Path.is_symlink
        • Path.iterdir
        • Path.lchmod
        • Path.link_to
        • Path.lstat
        • Path.mkdir
        • Path.open
        • Path.owner
        • Path.read_bytes
        • Path.read_text
        • Path.readlink
        • Path.rename
        • Path.replace
        • Path.resolve
        • Path.rglob
        • Path.rmdir
        • Path.samefile
        • Path.stat
        • Path.symlink_to
        • Path.touch
        • Path.unlink
        • Path.write_bytes
        • Path.write_text
      • CUBEMatConverterError
    • caf.mat.direction
      • caf.mat.direction.factors
        • load_occupancies
        • Collection
        • Mapping
        • OccupanciesParameters
        • PhiFactors
        • PhiFactorsParameters
        • Sequence
        • InvalidPhiFactorsError
        • UnexpectedPhiFactorsWarning
      • caf.mat.direction.od_to_pa
        • balance_fh_th_by_op
        • balance_fh_th_conserve_24hr
        • disaggregate_postme
        • main
        • nhb_proportions
        • od_to_pa
        • OD2PAParameters
        • Sequence
        • TypeVar
    • caf.mat.matrices
      • Iterator
      • LongMatrices
        • LongMatrices.__init__
        • LongMatrices.exists
        • LongMatrices.from_csv
        • LongMatrices.get_matrix
        • LongMatrices.new
        • LongMatrices.save_csv
        • LongMatrices.set_matrix
        • LongMatrices.to_frame
      • MatricesBase
        • MatricesBase.__init__
        • MatricesBase.aggregate
        • MatricesBase.disaggregate
        • MatricesBase.exists
        • MatricesBase.get_matrix
        • MatricesBase.new
        • MatricesBase.set_matrix
        • MatricesBase.validate_matrix
        • MatricesBase.validate_slice
      • Matrix
        • Matrix.__init__
      • MatrixFiles
        • MatrixFiles.__init__
        • MatrixFiles.exists
        • MatrixFiles.get_matrix
        • MatrixFiles.new
        • MatrixFiles.set_matrix
      • MatrixType
      • MemoryMatrices
        • MemoryMatrices.__init__
        • MemoryMatrices.exists
        • MemoryMatrices.get_matrix
        • MemoryMatrices.new
        • MemoryMatrices.set_matrix
      • MatricesWarning
      • PAError
    • caf.mat.omx
      • Generator
        • Generator.close
        • Generator.send
        • Generator.throw
      • OMXFile
        • OMXFile.__init__
        • OMXFile.get_all
        • OMXFile.get_matrix_array
        • OMXFile.get_matrix_level
        • OMXFile.set_matrix_level
        • OMXFile.to_csvs
      • Path
        • Path.absolute
        • Path.chmod
        • Path.cwd
        • Path.exists
        • Path.expanduser
        • Path.glob
        • Path.group
        • Path.hardlink_to
        • Path.home
        • Path.is_block_device
        • Path.is_char_device
        • Path.is_dir
        • Path.is_fifo
        • Path.is_file
        • Path.is_mount
        • Path.is_socket
        • Path.is_symlink
        • Path.iterdir
        • Path.lchmod
        • Path.link_to
        • Path.lstat
        • Path.mkdir
        • Path.open
        • Path.owner
        • Path.read_bytes
        • Path.read_text
        • Path.readlink
        • Path.rename
        • Path.replace
        • Path.resolve
        • Path.rglob
        • Path.rmdir
        • Path.samefile
        • Path.stat
        • Path.symlink_to
        • Path.touch
        • Path.unlink
        • Path.write_bytes
        • Path.write_text
      • OMXWarning
    • caf.mat.ufm
      • update_env
      • CSVFormat
      • UFMConverter
        • UFMConverter.__init__
        • UFMConverter.csv_to_ufm
        • UFMConverter.omx_to_ufm
        • UFMConverter.stack
        • UFMConverter.ufm_to_csv
        • UFMConverter.ufm_to_omx
        • UFMConverter.ufm_to_square_csvs

Indices

  • General Index
  • Python Module Index
  • API Reference
  • caf.mat
  • caf.mat.omx
  • Path
  • Path.readlink

Path.readlink#

Path.readlink()#

Return the path to which the symbolic link points.

previous

Path.read_text

next

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

© Copyright 2026, Transport for the North.

Created using Sphinx 9.0.4.

Built with the PyData Sphinx Theme 0.19.0.