Welcome to megfile’s documentation!

Contents:

• Getting Started
  • megfile - Megvii FILE library
  • Why megfile
  • Support Protocols
  • Quick Start
    • Functional Interface
    • SmartPath Interface
    • Command Line Interface
  • Installation
    • PyPI
  • Configuration
    • Use environments
    • Use command
    • Create aliases
  • Benchmark
  • How to Contribute
• Path Format
  • fs
  • s3
  • http
    • set cookies, headers and other parameters
  • stdio
  • sftp
  • hdfs
  • webdav
• Configuration
  • Common Configuration
    • Environment configurations
  • S3 Configuration
    • Use environments
    • Use command
    • Config for different s3 server or authentications
      • Using environment
      • Using command:
  • Hdfs Configuration
    • Use environments
    • Use command
    • Config for different hdfs server
      • Using environment
      • Using command:
  • Sftp Configuration
    • Use environments
  • HTTP Configuration
    • HTTP Environment configurations
  • WebDAV Configuration
    • Use environments
  • Auto Completion
    • Environment configurations
• API Reference
  • megfile.smart module
    • SmartCacher
      • SmartCacher.cache_path
    • register_copy_func()
    • smart_abspath()
    • smart_access()
    • smart_cache()
    • smart_combine_open()
    • smart_concat()
    • smart_copy()
    • smart_exists()
    • smart_getmd5()
    • smart_getmtime()
    • smart_getsize()
    • smart_glob()
    • smart_glob_stat()
    • smart_iglob()
    • smart_isabs()
    • smart_isdir()
    • smart_isfile()
    • smart_islink()
    • smart_ismount()
    • smart_listdir()
    • smart_load_content()
    • smart_load_from()
    • smart_load_text()
    • smart_makedirs()
    • smart_move()
    • smart_open()
    • smart_path_join()
    • smart_readlink()
    • smart_realpath()
    • smart_relpath()
    • smart_remove()
    • smart_rename()
    • smart_save_as()
    • smart_save_content()
    • smart_save_text()
    • smart_scan()
    • smart_scan_stat()
    • smart_scandir()
    • smart_stat()
    • smart_symlink()
    • smart_sync()
    • smart_sync_with_progress()
    • smart_touch()
    • smart_unlink()
    • smart_walk()
  • megfile.smart_path module
    • SmartPath
      • SmartPath.absolute()
      • SmartPath.abspath()
      • SmartPath.access()
      • SmartPath.anchor
      • SmartPath.as_posix()
      • SmartPath.as_uri()
      • SmartPath.chmod()
      • SmartPath.cwd()
      • SmartPath.drive
      • SmartPath.exists()
      • SmartPath.expanduser()
      • SmartPath.from_uri()
      • SmartPath.getmtime()
      • SmartPath.getsize()
      • SmartPath.glob()
      • SmartPath.glob_stat()
      • SmartPath.group()
      • SmartPath.hardlink_to()
      • SmartPath.home()
      • SmartPath.iglob()
      • SmartPath.is_absolute()
      • SmartPath.is_block_device()
      • SmartPath.is_char_device()
      • SmartPath.is_dir()
      • SmartPath.is_fifo()
      • SmartPath.is_file()
      • SmartPath.is_mount()
      • SmartPath.is_relative_to()
      • SmartPath.is_reserved()
      • SmartPath.is_socket()
      • SmartPath.is_symlink()
      • SmartPath.iterdir()
      • SmartPath.joinpath()
      • SmartPath.lchmod()
      • SmartPath.listdir()
      • SmartPath.load()
      • SmartPath.lstat()
      • SmartPath.match()
      • SmartPath.md5()
      • SmartPath.mkdir()
      • SmartPath.name
      • SmartPath.open()
      • SmartPath.owner()
      • SmartPath.parent
      • SmartPath.parents
      • SmartPath.parts
      • SmartPath.read_bytes()
      • SmartPath.read_text()
      • SmartPath.readlink()
      • SmartPath.realpath()
      • SmartPath.register()
      • SmartPath.relative_to()
      • SmartPath.relpath()
      • SmartPath.remove()
      • SmartPath.rename()
      • SmartPath.replace()
      • SmartPath.resolve()
      • SmartPath.rglob()
      • SmartPath.rmdir()
      • SmartPath.root
      • SmartPath.samefile()
      • SmartPath.save()
      • SmartPath.scan()
      • SmartPath.scan_stat()
      • SmartPath.scandir()
      • SmartPath.stat()
      • SmartPath.stem
      • SmartPath.suffix
      • SmartPath.suffixes
      • SmartPath.symlink()
      • SmartPath.symlink_to()
      • SmartPath.touch()
      • SmartPath.unlink()
      • SmartPath.utime()
      • SmartPath.walk()
      • SmartPath.with_name()
      • SmartPath.with_stem()
      • SmartPath.with_suffix()
      • SmartPath.write_bytes()
      • SmartPath.write_text()
    • get_traditional_path()
  • Submodules
    • megfile.fs_path module
      • FSPath
      • fs_copy()
      • is_fs()
    • megfile.s3_path module
      • S3Cacher
      • S3Path
      • get_endpoint_url()
      • get_s3_client()
      • get_s3_session()
      • is_s3()
      • parse_s3_url()
      • s3_buffered_open()
      • s3_cached_open()
      • s3_concat()
      • s3_copy()
      • s3_download()
      • s3_load_content()
      • s3_memory_open()
      • s3_open()
      • s3_pipe_open()
      • s3_prefetch_open()
      • s3_share_cache_open()
      • s3_upload()
    • megfile.http_path module
      • HttpPath
      • HttpsPath
      • get_http_session()
      • is_http()
    • megfile.stdio_path module
      • StdioPath
      • is_stdio()
    • megfile.sftp_path module
      • SftpPath
      • is_sftp()
      • sftp_add_host_key()
      • sftp_concat()
      • sftp_copy()
      • sftp_download()
      • sftp_upload()
    • megfile.hdfs_path module
      • HdfsPath
      • is_hdfs()
    • megfile.webdav_path module
• Command Line Interface
  • megfile
    • cat
    • completion
      • bash
      • fish
      • zsh
    • config
      • alias
      • env
      • hdfs
      • s3
    • cp
    • head
    • ll
    • ls
    • md5sum
    • mkdir
    • mtime
    • mv
    • rm
    • size
    • stat
    • sync
    • tail
    • to
    • touch
    • version
• Advanced User Guide
  • Define Custom Protocol
  • Glob Pattern
    • Patterns are Unix shell style:
• Benchmark
  • version
  • Result
• CHANGELOG
  • 5.0.2 - 2025.11.25
  • 5.0.1 - 2025.11.14
  • 5.0.0 - 2025.11.11
  • 4.2.5 - 2025.10.20
  • 4.2.4 - 2025.09.01
  • 4.2.3 - 2025.08.13
  • 4.2.2 - 2025.08.04
  • 4.2.1 - 2025.07.15
  • 4.2.0 - 2025.07.04
  • 4.1.8.post1 - 2025.07.03
  • 4.1.8 - 2025.06.13
  • 4.1.7 - 2025.05.28
  • 4.1.6 - 2025.04.30
  • 4.1.5 - 2025.04.28
  • 4.1.4.post1 - 2025.04.25
  • 4.1.4 - 2025.04.14
  • 4.1.3.post2 - 2025.04.10
  • 4.1.3.post1 - 2025.03.31
  • 4.1.3 - 2025.03.31
  • 4.1.2 - 2025.03.07
  • 4.1.1 - 2025.02.05
  • 4.1.0.post3 - 2025.01.23
  • 4.1.0.post2 - 2025.01.17
  • 4.1.0.post1 - 2025.01.10
  • 4.1.0 - 2025.01.09
  • 4.0.4 - 2025.01.03
  • 4.0.3 - 2024.12.26
  • 4.0.2 - 2024.12.20
  • 4.0.1 - 2024.12.12
  • 4.0.0.post1 - 2024.12.09
  • 4.0.0 - 2024.12.06
  • 3.1.7 - 2024.12.12
  • 3.1.6.post1 - 2024.11.18
  • 3.1.6 - 2024.11.14
  • 3.1.5 - 2024.11.05
  • 3.1.4 - 2024.11.01
  • 3.1.3 - 2024.08.23
  • 3.1.2 - 2024.08.12
  • 3.1.1 - 2024.07.24
  • 3.1.0.post2 - 2024.07.22
  • 3.1.0.post1 - 2024.07.15
  • 3.1.0 - 2024.07.09
  • 3.0.6.post1 - 2024.06.21
  • 3.0.6 - 2024.06.12
  • 3.0.5 - 2024.05.28
  • 3.0.4 - 2024.05.16
  • 3.0.3 - 2024.05.10
  • 3.0.2.post1 - 2024.04.25
  • 3.0.2 - 2024.04.24
  • 3.0.1 - 2024.03.08
  • 3.0.0.post1 - 2024.01.22
  • 3.0.0 - 2024.01.22
  • 2.2.10.post1 - 2024.01.04
  • 2.2.10 - 2023.12.12
  • 2.2.9.post5 - 2023.11.26
  • 2.2.9.post4 - 2023.11.17
  • 2.2.9.post3 - 2023.11.09
  • 2.2.9.post2 - 2023.11.08
  • 2.2.9.post1 - 2023.11.02
  • 2.2.9 - 2023.10.31
  • 2.2.8.post2 - 2023.10.25
  • 2.2.8.post1 - 2023.10.20
  • 2.2.8 - 2023.10.17
  • 2.2.7 - 2023.10.08
  • 2.2.6 - 2023.09.22
  • 2.2.5.post1 - 2023.09.19
  • 2.2.5 - 2023.09.15
  • 2.2.4.post1 - 2023.09.04
  • 2.2.4 - 2023.09.04
  • 2.2.3 - 2023.08.25
  • 2.2.2 - 2023.08.18
  • 2.2.1.post1 - 2023.08.14
  • 2.2.1 - 2023.08.07
  • 2.2.0.post1 - 2023.08.03
  • 2.2.0 - 2023.08.01
  • 2.1.4 - 2023.07.21
  • 2.1.3.post1 - 2023.07.13
  • 2.1.3 - 2023.07.11
  • 2.1.2 - 2023.07.07
  • 2.1.1.post2 - 2023.07.07
  • 2.1.1.post1 - 2023.07.04
  • 2.1.1 - 2023.07.03
  • 2.1.0 - 2023.06.26
  • 2.0.7 - 2023.06.16
  • 2.0.6.post1 - 2023.06.16
  • 2.0.6 - 2023.06.13
  • 2.0.5.post1 - 2023.05.11
  • 2.0.5 - 2023.05.11
  • 2.0.4 - 2023.04.12
  • 2.0.3 - 2023.03.22
  • 2.0.2 - 2023.03.13
  • 2.0.1 - 2023.03.01
  • 2.0.0 - 2023.02.10
  • 1.0.2 - 2022.09.22
  • 1.0.1 - 2022.08.04
  • 1.0.0 - 2022.07.25
  • 0.1.2 - 2022.04.26
  • 0.1.1 - 2022.01.14
  • 0.1.0 - 2022.01.14
  • 0.0.11 - 2021.12.08
  • 0.0.10 - 2021.11.29
  • 0.0.9 - 2021.10.11
  • 0.0.8 - 2021.09.15
  • 0.0.7 - 2021.09.06
  • 0.0.6 - 2021.09.01
  • 0.0.5 - 2021.08.31
  • 0.0.4 - 2021.08.29
  • 0.0.3 - 2021.08.24
• GitHub

Indices and tables

• Index

• Module Index

• Search Page