bandersnatch

• bandersnatch package
  • Package contents
  • Submodules
  • bandersnatch.configuration module
    • BandersnatchConfig
      • BandersnatchConfig.SHOWN_DEPRECATIONS
      • BandersnatchConfig.check_for_deprecations()
      • BandersnatchConfig.optionxform()
    • SetConfigValues
      • SetConfigValues.cleanup
      • SetConfigValues.compare_method
      • SetConfigValues.diff_append_epoch
      • SetConfigValues.diff_file_path
      • SetConfigValues.digest_name
      • SetConfigValues.download_mirror
      • SetConfigValues.download_mirror_no_fallback
      • SetConfigValues.json_save
      • SetConfigValues.release_files_save
      • SetConfigValues.root_uri
      • SetConfigValues.simple_format
      • SetConfigValues.storage_backend_name
    • Singleton
    • create_example_config()
    • validate_config_values()
  • bandersnatch.delete module
    • delete_packages()
    • delete_path()
    • delete_simple_page()
  • bandersnatch.filter module
    • Filter
      • Filter.allowlist
      • Filter.blocklist
      • Filter.check_match()
      • Filter.deprecated_name
      • Filter.filter()
      • Filter.initialize_plugin()
      • Filter.name
      • Filter.pinned_version_exists()
    • FilterMetadataPlugin
      • FilterMetadataPlugin.name
    • FilterProjectPlugin
      • FilterProjectPlugin.name
    • FilterReleaseFilePlugin
      • FilterReleaseFilePlugin.name
    • FilterReleasePlugin
      • FilterReleasePlugin.name
    • LoadedFilters
      • LoadedFilters.ENTRYPOINT_GROUPS
      • LoadedFilters.filter_metadata_plugins()
      • LoadedFilters.filter_project_plugins()
      • LoadedFilters.filter_release_file_plugins()
      • LoadedFilters.filter_release_plugins()
      • LoadedFilters.loaded_filter_plugins
  • bandersnatch.log module
    • setup_logging()
  • bandersnatch.main module
    • async_main()
    • main()
  • bandersnatch.master module
    • Master
      • Master.all_packages()
      • Master.changed_packages()
      • Master.check_for_stale_cache()
      • Master.fetch_simple_index()
      • Master.get()
      • Master.get_package_metadata()
      • Master.simple_url
      • Master.url_fetch()
    • StalePage
  • bandersnatch.mirror module
    • BandersnatchMirror
      • BandersnatchMirror.cleanup_non_pep_503_paths()
      • BandersnatchMirror.determine_packages_to_sync()
      • BandersnatchMirror.download_file()
      • BandersnatchMirror.errors
      • BandersnatchMirror.finalize_sync()
      • BandersnatchMirror.find_target_serial()
      • BandersnatchMirror.generationfile
      • BandersnatchMirror.json_file()
      • BandersnatchMirror.json_pypi_symlink()
      • BandersnatchMirror.need_index_sync
      • BandersnatchMirror.need_wrapup
      • BandersnatchMirror.on_error()
      • BandersnatchMirror.populate_download_urls()
      • BandersnatchMirror.process_package()
      • BandersnatchMirror.record_finished_package()
      • BandersnatchMirror.save_json_metadata()
      • BandersnatchMirror.simple_directory()
      • BandersnatchMirror.statusfile
      • BandersnatchMirror.sync_release_files()
      • BandersnatchMirror.sync_simple_pages()
      • BandersnatchMirror.todolist
      • BandersnatchMirror.webdir
      • BandersnatchMirror.wrapup_successful_sync()
      • BandersnatchMirror.write_simple_pages()
    • Mirror
      • Mirror.altered_packages
      • Mirror.determine_packages_to_sync()
      • Mirror.finalize_sync()
      • Mirror.now
      • Mirror.on_error()
      • Mirror.package_syncer()
      • Mirror.packages_to_sync
      • Mirror.process_package()
      • Mirror.sync_packages()
      • Mirror.synced_serial
      • Mirror.synchronize()
      • Mirror.target_serial
    • fetch_and_store()
    • mirror()
  • bandersnatch.package module
    • Package
      • Package.filter_all_releases()
      • Package.filter_all_releases_files()
      • Package.filter_metadata()
      • Package.from_metadata()
      • Package.info
      • Package.last_serial
      • Package.metadata
      • Package.release_files
      • Package.releases
      • Package.update_metadata()
  • bandersnatch.storage module
    • FileSpec
      • FileSpec.digests
      • FileSpec.filename
      • FileSpec.path
      • FileSpec.size
      • FileSpec.upload_time
      • FileSpec.url
    • Storage
      • Storage.PATH_BACKEND
      • Storage.canonicalize_package()
      • Storage.compare_files()
      • Storage.copy_file()
      • Storage.delete()
      • Storage.delete_file()
      • Storage.delete_package_file()
      • Storage.directory
      • Storage.exists()
      • Storage.find()
      • Storage.flock_path
      • Storage.get_file_size()
      • Storage.get_hash()
      • Storage.get_json_paths()
      • Storage.get_lock()
      • Storage.get_upload_time()
      • Storage.hash_file()
      • Storage.initialize_plugin()
      • Storage.is_dir()
      • Storage.is_file()
      • Storage.iter_dir()
      • Storage.iter_package_files()
      • Storage.mkdir()
      • Storage.move_file()
      • Storage.name
      • Storage.open_file()
      • Storage.read_file()
      • Storage.rewrite()
      • Storage.rmdir()
      • Storage.scandir()
      • Storage.set_hash()
      • Storage.set_upload_time()
      • Storage.stamp_file_metadata()
      • Storage.symlink()
      • Storage.update_safe()
      • Storage.verify_files()
      • Storage.write_file()
    • StorageDirEntry
      • StorageDirEntry.is_dir()
      • StorageDirEntry.is_file()
      • StorageDirEntry.is_symlink()
      • StorageDirEntry.name
      • StorageDirEntry.path
    • StoragePlugin
      • StoragePlugin.name
    • load_storage_plugins()
    • storage_backend_plugins()
  • bandersnatch.utils module
    • StrEnum
      • StrEnum.value
    • bandersnatch_safe_name()
    • convert_url_to_path()
    • find()
    • find_all_files()
    • hash()
    • make_time_stamp()
    • parse_version()
    • removeprefix()
    • rewrite()
    • unlink_parent_dir()
    • user_agent()
  • bandersnatch.verify module
    • DownloadStats
      • DownloadStats.file_count
      • DownloadStats.record_size()
      • DownloadStats.total_bytes
      • DownloadStats.unknown_size_count
    • delete_unowned_files()
    • get_latest_json()
    • load_package()
    • log_download_summary()
    • metadata_verify()
    • on_error()
    • verify()
    • verify_producer()
• bandersnatch_filter_plugins package
  • Package contents
  • Submodules
  • bandersnatch_filter_plugins.blocklist_name module
    • BlockListProject
      • BlockListProject.blocklist_package_names
      • BlockListProject.check_match()
      • BlockListProject.filter()
      • BlockListProject.initialize_plugin()
      • BlockListProject.name
    • BlockListRelease
      • BlockListRelease.blocklist_package_names
      • BlockListRelease.filter()
      • BlockListRelease.initialize_plugin()
      • BlockListRelease.name
  • bandersnatch_filter_plugins.filename_name module
    • ExcludePlatformFilter
      • ExcludePlatformFilter.filter()
      • ExcludePlatformFilter.initialize_plugin()
      • ExcludePlatformFilter.name
  • bandersnatch_filter_plugins.latest_name module
    • LatestReleaseFilter
      • LatestReleaseFilter.filter()
      • LatestReleaseFilter.initialize_plugin()
      • LatestReleaseFilter.keep
      • LatestReleaseFilter.name
      • LatestReleaseFilter.sort_by
  • bandersnatch_filter_plugins.metadata_filter module
    • RegexFilter
      • RegexFilter.filter()
      • RegexFilter.initialize_plugin()
      • RegexFilter.initialized
      • RegexFilter.match_patterns
      • RegexFilter.name
      • RegexFilter.nulls_match
      • RegexFilter.patterns
    • RegexProjectMetadataFilter
      • RegexProjectMetadataFilter.filter()
      • RegexProjectMetadataFilter.initialized
      • RegexProjectMetadataFilter.initilize_plugin()
      • RegexProjectMetadataFilter.match_patterns
      • RegexProjectMetadataFilter.name
      • RegexProjectMetadataFilter.nulls_match
      • RegexProjectMetadataFilter.patterns
    • RegexReleaseFileMetadataFilter
      • RegexReleaseFileMetadataFilter.filter()
      • RegexReleaseFileMetadataFilter.initialized
      • RegexReleaseFileMetadataFilter.initilize_plugin()
      • RegexReleaseFileMetadataFilter.match_patterns
      • RegexReleaseFileMetadataFilter.name
      • RegexReleaseFileMetadataFilter.nulls_match
      • RegexReleaseFileMetadataFilter.patterns
    • SizeProjectMetadataFilter
      • SizeProjectMetadataFilter.allowlist_package_names
      • SizeProjectMetadataFilter.filter()
      • SizeProjectMetadataFilter.initialize_plugin()
      • SizeProjectMetadataFilter.initialized
      • SizeProjectMetadataFilter.max_package_size
      • SizeProjectMetadataFilter.name
    • VersionRangeFilter
      • VersionRangeFilter.filter()
      • VersionRangeFilter.initialize_plugin()
      • VersionRangeFilter.initialized
      • VersionRangeFilter.name
      • VersionRangeFilter.nulls_match
      • VersionRangeFilter.specifiers
    • VersionRangeProjectMetadataFilter
      • VersionRangeProjectMetadataFilter.filter()
      • VersionRangeProjectMetadataFilter.initialize_plugin()
      • VersionRangeProjectMetadataFilter.initialized
      • VersionRangeProjectMetadataFilter.name
      • VersionRangeProjectMetadataFilter.nulls_match
      • VersionRangeProjectMetadataFilter.specifiers
    • VersionRangeReleaseFileMetadataFilter
      • VersionRangeReleaseFileMetadataFilter.filter()
      • VersionRangeReleaseFileMetadataFilter.initialize_plugin()
      • VersionRangeReleaseFileMetadataFilter.initialized
      • VersionRangeReleaseFileMetadataFilter.name
      • VersionRangeReleaseFileMetadataFilter.nulls_match
      • VersionRangeReleaseFileMetadataFilter.specifiers
    • VersionsCountProjectMetadataFilter
      • VersionsCountProjectMetadataFilter.allowlist_package_names
      • VersionsCountProjectMetadataFilter.filter()
      • VersionsCountProjectMetadataFilter.initialize_plugin()
      • VersionsCountProjectMetadataFilter.initialized
      • VersionsCountProjectMetadataFilter.max_versions
      • VersionsCountProjectMetadataFilter.min_versions
      • VersionsCountProjectMetadataFilter.name
  • bandersnatch_filter_plugins.prerelease_name module
    • PreReleaseFilter
      • PreReleaseFilter.PRERELEASE_PATTERNS
      • PreReleaseFilter.filter()
      • PreReleaseFilter.initialize_plugin()
      • PreReleaseFilter.name
      • PreReleaseFilter.package_names
      • PreReleaseFilter.patterns
  • bandersnatch_filter_plugins.regex_name module
    • RegexProjectFilter
      • RegexProjectFilter.check_match()
      • RegexProjectFilter.filter()
      • RegexProjectFilter.initialize_plugin()
      • RegexProjectFilter.name
      • RegexProjectFilter.patterns
    • RegexReleaseFilter
      • RegexReleaseFilter.filter()
      • RegexReleaseFilter.initialize_plugin()
      • RegexReleaseFilter.name
      • RegexReleaseFilter.patterns
  • bandersnatch_filter_plugins.allowlist_name module
    • AllowListProject
      • AllowListProject.allowlist_package_names
      • AllowListProject.check_match()
      • AllowListProject.filter()
      • AllowListProject.initialize_plugin()
      • AllowListProject.name
    • AllowListRelease
      • AllowListRelease.allowlist_package_names
      • AllowListRelease.filter()
      • AllowListRelease.initialize_plugin()
      • AllowListRelease.name
      • AllowListRelease.pinned_version_exists()
    • AllowListRequirements
      • AllowListRequirements.name
    • AllowListRequirementsPinned
      • AllowListRequirementsPinned.name
    • get_requirement_files()
• bandersnatch_storage_plugins package
  • Package contents
  • Submodules
  • bandersnatch_storage_plugins.filesystem module
    • FilesystemStorage
      • FilesystemStorage.PATH_BACKEND
      • FilesystemStorage.compare_files()
      • FilesystemStorage.copy_file()
      • FilesystemStorage.delete_file()
      • FilesystemStorage.delete_package_file()
      • FilesystemStorage.exists()
      • FilesystemStorage.find()
      • FilesystemStorage.get_file_size()
      • FilesystemStorage.get_hash()
      • FilesystemStorage.get_lock()
      • FilesystemStorage.get_upload_time()
      • FilesystemStorage.initialize_plugin()
      • FilesystemStorage.is_dir()
      • FilesystemStorage.is_file()
      • FilesystemStorage.mkdir()
      • FilesystemStorage.move_file()
      • FilesystemStorage.name
      • FilesystemStorage.open_file()
      • FilesystemStorage.read_file()
      • FilesystemStorage.rewrite()
      • FilesystemStorage.rmdir()
      • FilesystemStorage.scandir()
      • FilesystemStorage.set_upload_time()
      • FilesystemStorage.update_safe()
      • FilesystemStorage.walk()
      • FilesystemStorage.write_file()