swh.core package

Subpackages:

• swh.core.api package
  • swh.core.api.asynchronous module
    • encode_msgpack()
    • render_msgpack()
    • render_json()
    • decode_data()
    • decode_request()
    • error_middleware()
    • RPCServerApp
    • SWHRemoteAPI
  • swh.core.api.classes module
    • PagedResult
    • stream_results()
    • stream_results_optional()
  • swh.core.api.gunicorn_config module
    • post_fork()
  • swh.core.api.negotiation module
    • FormatterNotFound
    • Formatter
    • Negotiator
    • negotiate()
  • swh.core.api.serializers module
    • encode_datetime()
    • exception_to_dict()
    • dict_to_exception()
    • encode_timedelta()
    • get_encoders()
    • get_decoders()
    • MsgpackExtTypeCodes
    • encode_data_client()
    • decode_response()
    • SWHJSONEncoder
    • SWHJSONDecoder
    • json_dumps()
    • json_loads()
    • msgpack_dumps()
    • msgpack_loads()
  • get_distribution_version_for_class()
  • format_user_agent()
  • Negotiator
    • Negotiator.best_mimetype()
  • negotiate()
  • Formatter
    • Formatter.configure()
  • JSONFormatter
    • JSONFormatter.format
    • JSONFormatter.mimetypes
    • JSONFormatter.render()
  • MsgpackFormatter
    • MsgpackFormatter.format
    • MsgpackFormatter.mimetypes
    • MsgpackFormatter.render()
  • RemoteException
    • RemoteException.response
  • TransientRemoteException
  • remote_api_endpoint()
  • APIError
  • MetaRPCClient
  • RPCClient
    • RPCClient.backend_class
    • RPCClient.extra_type_encoders
    • RPCClient.extra_type_decoders
    • RPCClient.api_exception
    • RPCClient.reraise_exceptions
    • RPCClient.enable_requests_retry
    • RPCClient.retry_policy()
    • RPCClient.raw_verb()
    • RPCClient.post()
    • RPCClient.post_stream()
    • RPCClient.get()
    • RPCClient.get_stream()
    • RPCClient.raise_for_status()
  • BytesRequest
    • BytesRequest.encoding
    • BytesRequest.encoding_errors
  • encode_data_server()
  • decode_request()
  • error_handler()
  • RPCServerApp
    • RPCServerApp.request_class
    • RPCServerApp.extra_type_encoders
    • RPCServerApp.extra_type_decoders
    • RPCServerApp.method_decorators
    • RPCServerApp.exception_status_codes
    • RPCServerApp.add_backend_class()
    • RPCServerApp.setup_psycopg_errorhandlers()
• swh.core.cli package
  • swh.core.cli.backend module
  • swh.core.cli.db module
    • initialize_one()
    • get_dburl_from_config()
    • get_dburl_from_config_key()
    • handle_cmd_args()
  • swh.core.cli.nar module
  • swh.core.cli.sentry module
    • common_options()
  • SWHHelpFormatter
    • SWHHelpFormatter.write_text()
  • AliasedGroup
    • AliasedGroup.get_command()
    • AliasedGroup.add_alias()
    • AliasedGroup.format_options()
  • clean_exit_on_signal()
  • validate_loglevel_params()
  • main()
• swh.core.db package
  • swh.core.db.common module
    • remove_kwargs()
    • apply_options()
    • db_transaction()
    • db_transaction_generator()
  • swh.core.db.db_utils module
    • now()
    • stored_procedure()
    • jsonize()
    • connect_to_conninfo()
    • swh_db_version()
    • swh_db_versions()
    • swh_db_upgrade()
    • swh_db_module()
    • swh_set_db_module()
    • swh_set_db_version()
    • swh_db_flavor()
    • import_swhmodule()
    • get_sql_for_package()
    • populate_database_for_package()
    • initialize_database_for_module()
    • get_database_info()
    • parse_dsn_or_dbname()
    • init_admin_extensions()
    • create_database_for_package()
    • dsn_with_password()
    • execute_sqlfiles()
  • render_array()
  • render_array_element()
  • value_as_pg_text()
  • escape_copy_column()
  • BaseDb
    • BaseDb.connect()
    • BaseDb.from_pool()
    • BaseDb.close()
    • BaseDb.put_conn()
    • BaseDb.cursor()
    • BaseDb.transaction()
    • BaseDb.copy_to()
    • BaseDb.mktemp()
• swh.core.github package
  • swh.core.github.pytest_plugin module
    • fake_time_sleep()
    • fake_time_time()
    • monkeypatch_sleep_calls()
    • num_before_ratelimit()
    • num_ratelimit()
    • ratelimit_reset()
    • github_ratelimit_callback()
    • github_repo()
    • github_response_callback()
    • github_requests_ratelimited()
    • github_credentials()
    • all_tokens()
  • swh.core.github.utils module
    • get_canonical_github_origin_url()
    • RateLimited
    • MissingRateLimitReset
    • GitHubSession
• swh.core.s3 namespace
  • swh.core.s3.downloader module
    • S3Downloader
  • swh.core.s3.pytest_plugin module
    • add_files_to_s3_bucket()
    • s3_bucket_name()
    • s3_archives_url()
    • test_archives_path()
    • mocked_aws()

Submodules:

• swh.core.api_async module
• swh.core.collections module
  • SortedList
    • SortedList.data
    • SortedList.add()
    • SortedList.iter_from()
    • SortedList.iter_after()
• swh.core.config module
  • exists_accessible()
  • read_raw_config()
  • config_exists()
  • config_basepath()
  • config_path()
  • read()
  • priority_read()
  • merge_default_configs()
  • merge_configs()
  • swh_config_paths()
  • prepare_folders()
  • load_global_config()
  • load_named_config()
  • load_from_envvar()
  • get_swh_backend_module()
  • get_swh_backend_from_fullmodule()
  • list_swh_backends()
  • list_db_config_entries()
• swh.core.logger module
  • db_level_of_py_level()
  • get_extra_data()
  • flatten()
  • stringify()
  • JournalHandler
    • JournalHandler.emit()
• swh.core.logging module
  • BadLogLevel
  • validate_loglevel()
  • logging_configure()
• swh.core.nar module
  • Nar
    • Nar.str_()
    • Nar.update()
    • Nar.serialize()
    • Nar.digest()
    • Nar.hexdigest()
    • Nar.b64digest()
    • Nar.b32digest()
  • compute_nar_hashes()
  • nar_serialize()
  • nar_unpack()
• swh.core.pytest_plugin module
  • get_response_cb()
  • datadir()
  • requests_mock_datadir_factory()
  • requests_mock_datadir()
  • requests_mock_datadir_visits()
  • swh_rpc_client()
  • swh_rpc_adapter()
  • RPCTestAdapter
    • RPCTestAdapter.build_response()
    • RPCTestAdapter.send()
  • flask_app_client()
  • FakeSocket
    • FakeSocket.send()
    • FakeSocket.recv()
    • FakeSocket.close()
  • statsd()
  • monkeypatch_sentry_transport()
  • sentry_events()
  • clean_scopes()
  • mock_import_module()
  • mock_get_entry_points()
  • mock_get_swh_backend_module()
• swh.core.retry module
  • is_throttling_exception()
  • is_retryable_exception()
  • retry_if_exception()
  • retry_policy_generic()
  • http_retry()
• swh.core.sentry module
  • get_sentry_release()
  • override_with_bool_envvar()
  • override_with_float_envvar()
  • init_sentry()
• swh.core.statsd module
  • random()
  • TimedContextManagerDecorator
    • TimedContextManagerDecorator.elapsed
    • TimedContextManagerDecorator.total_elapsed
    • TimedContextManagerDecorator.start()
    • TimedContextManagerDecorator.stop()
  • Statsd
    • Statsd.gauge()
    • Statsd.increment()
    • Statsd.decrement()
    • Statsd.histogram()
    • Statsd.timing()
    • Statsd.timed()
    • Statsd.set()
    • Statsd.socket
    • Statsd.open_buffer()
    • Statsd.close_buffer()
    • Statsd.close_socket()
    • Statsd.status_gauge()
• swh.core.tarball module
  • register_new_archive_formats()
  • uncompress()
  • normalize_permissions()
  • compress()
• swh.core.utils module
  • cwd()
  • grouper()
  • iter_chunks()
  • backslashescape_errors()
  • encode_with_unescape()
  • decode_with_escape()
  • commonname()
  • numfile_sortkey()
  • basename_sortkey()

Module contents: