API Reference

• Python APIs
  • sphinx_bzl
    • Submodules
      • sphinx_bzl.bzl
        • Module Contents
          • Classes
          • Functions
          • Data
          • API
            • InvalidValueError
            • _BzlAspect
              • _BzlAspect.doc_field_types
            • _BzlAttrInfo
              • _BzlAttrInfo.has_content
              • _BzlAttrInfo.option_spec
              • _BzlAttrInfo.optional_arguments
              • _BzlAttrInfo.required_arguments
              • _BzlAttrInfo.run()
            • _BzlCallable
            • _BzlCsvField
              • _BzlCsvField.__init__()
              • _BzlCsvField.make_field()
            • _BzlCurrentFile
              • _BzlCurrentFile.final_argument_whitespace
              • _BzlCurrentFile.has_content
              • _BzlCurrentFile.required_arguments
              • _BzlCurrentFile.run()
            • _BzlDocField
            • _BzlDomain
              • _BzlDomain._find_entry_for_xref()
              • _BzlDomain.add_object()
              • _BzlDomain.directives
              • _BzlDomain.get_full_qualified_name()
              • _BzlDomain.get_objects()
              • _BzlDomain.indices
              • _BzlDomain.initial_data
              • _BzlDomain.label
              • _BzlDomain.merge_domaindata()
              • _BzlDomain.name
              • _BzlDomain.object_types
              • _BzlDomain.resolve_any_xref()
              • _BzlDomain.resolve_xref()
              • _BzlDomain.roles
            • _BzlField
              • _BzlField._get_alt_names()
              • _BzlField._get_signature_object_type()
              • _BzlField.option_spec
            • _BzlFlag
              • _BzlFlag._TARGET_TYPE
              • _BzlFlag._get_additional_index_types()
              • _BzlFlag._get_signature_object_type()
            • _BzlFunction
              • _BzlFunction._get_signature_object_type()
              • _BzlFunction.doc_field_types
            • _BzlGroupedField
            • _BzlIndex
              • _BzlIndex.generate()
              • _BzlIndex.localname
              • _BzlIndex.name
              • _BzlIndex.shortname
            • _BzlModuleExtension
              • _BzlModuleExtension._get_signature_object_type()
              • _BzlModuleExtension.doc_field_types
            • _BzlObject
              • _BzlObject._get_additional_index_types()
              • _BzlObject._get_alt_names()
              • _BzlObject._get_object_type_display_name()
              • _BzlObject._get_signature_object_type()
              • _BzlObject._object_hierarchy_parts()
              • _BzlObject._signature_add_object_type()
              • _BzlObject._toc_entry_name()
              • _BzlObject.add_target_and_index()
              • _BzlObject.after_content()
              • _BzlObject.before_content()
              • _BzlObject.handle_signature()
              • _BzlObject.option_spec
              • _BzlObject.transform_content()
            • _BzlObjectId
              • _BzlObjectId.__init__()
              • _BzlObjectId.__repr__()
              • _BzlObjectId.from_env()
            • _BzlProvider
            • _BzlProviderField
            • _BzlRepositoryRule
              • _BzlRepositoryRule._get_signature_object_type()
              • _BzlRepositoryRule.doc_field_types
            • _BzlRule
              • _BzlRule.doc_field_types
            • _BzlTagClass
              • _BzlTagClass._get_alt_names()
              • _BzlTagClass._get_signature_object_type()
              • _BzlTagClass.doc_field_types
            • _BzlTarget
              • _BzlTarget._TARGET_TYPE
              • _BzlTarget._get_signature_object_type()
              • _BzlTarget.handle_signature()
            • _BzlTypedef
            • _BzlXrefField
              • _BzlXrefField._make_xrefs_for_arg_attr()
              • _BzlXrefField.make_xrefs()
            • _DefaultValueRole
              • _DefaultValueRole.run()
            • _GetObjectsTuple
            • _INDEX_SUBTYPE_ENTRY_WITH_SUB_ENTRIES
            • _INDEX_SUBTYPE_NORMAL
            • _INDEX_SUBTYPE_SUB_ENTRY
            • _LOG_PREFIX
            • _ObjectEntry
              • _ObjectEntry.__init__()
              • _ObjectEntry.__repr__()
              • _ObjectEntry.to_get_objects_tuple()
            • _RequiredProvidersRole
              • _RequiredProvidersRole.run()
            • _ReturnTypeRole
              • _ReturnTypeRole.run()
            • _RoleRunResult
            • _T
            • _TargetType
              • _TargetType.FLAG
              • _TargetType.TARGET
            • _TypeExprParser
              • _TypeExprParser.__init__()
              • _TypeExprParser._append()
              • _TypeExprParser._append_and_push()
              • _TypeExprParser.generic_visit()
              • _TypeExprParser.visit_Attribute()
              • _TypeExprParser.visit_BinOp()
              • _TypeExprParser.visit_Constant()
              • _TypeExprParser.visit_Expr()
              • _TypeExprParser.visit_List()
              • _TypeExprParser.visit_Name()
              • _TypeExprParser.visit_Subscript()
              • _TypeExprParser.visit_Tuple()
              • _TypeExprParser.xrefs_from_type_expr()
            • _TypeRole
              • _TypeRole.__init__()
              • _TypeRole.run()
            • _full_id_from_env()
            • _full_id_from_parts()
            • _index_node_tuple()
            • _log_debug()
            • _logger
            • _on_missing_reference()
            • _parse_full_id()
            • _position_iter()
            • setup()
  • runfiles
    • Submodules
      • runfiles.runfiles
        • Module Contents
          • Classes
          • Functions
          • Data
          • API
            • Create()
            • CreateDirectoryBased()
            • CreateManifestBased()
            • Runfiles
              • Runfiles.Create()
              • Runfiles.CreateDirectoryBased()
              • Runfiles.CreateManifestBased()
              • Runfiles.CurrentRepository()
              • Runfiles.EnvVars()
              • Runfiles.Rlocation()
              • Runfiles.__init__()
            • _DirectoryBased
              • _DirectoryBased.EnvVars()
              • _DirectoryBased.RlocationChecked()
              • _DirectoryBased.__init__()
            • _FindPythonRunfilesRoot()
            • _ManifestBased
              • _ManifestBased.EnvVars()
              • _ManifestBased.RlocationChecked()
              • _ManifestBased._GetRunfilesDir()
              • _ManifestBased._LoadRunfiles()
              • _ManifestBased.__init__()
            • _ParseRepoMapping()
            • _Runfiles
• rules_python Bazel APIs
  • //python/api:api.bzl
    • py_common.get
  • //python/cc
  • //python/cc:py_cc_toolchain.bzl
    • py_cc_toolchain
  • //python/cc:py_cc_toolchain_info.bzl
    • PyCcToolchainInfo
      • PyCcToolchainInfo.<init>
      • PyCcToolchainInfo.headers
      • PyCcToolchainInfo.libs
      • PyCcToolchainInfo.python_version
  • //python/config_settings
  • //python:defs.bzl
    • current_py_toolchain
    • find_requirements
    • py_binary
    • py_import
    • py_library
    • py_runtime
    • py_runtime_pair
    • py_test
    • PyInfo
      • PyInfo.<init>
      • PyInfo.direct_pyc_files
      • PyInfo.has_py2_only_sources
      • PyInfo.has_py3_only_sources
      • PyInfo.imports
      • PyInfo.transitive_implicit_pyc_files
      • PyInfo.transitive_implicit_pyc_source_files
      • PyInfo.transitive_pyc_files
      • PyInfo.transitive_sources
      • PyInfo.uses_shared_libraries
    • PyRuntimeInfo
      • PyRuntimeInfo.<init>
      • PyRuntimeInfo.abi_flags
      • PyRuntimeInfo.bootstrap_template
      • PyRuntimeInfo.coverage_files
      • PyRuntimeInfo.coverage_tool
      • PyRuntimeInfo.files
      • PyRuntimeInfo.implementation_name
      • PyRuntimeInfo.interpreter
      • PyRuntimeInfo.interpreter_path
      • PyRuntimeInfo.interpreter_version_info
      • PyRuntimeInfo.pyc_tag
      • PyRuntimeInfo.python_version
      • PyRuntimeInfo.site_init_template
      • PyRuntimeInfo.stage2_bootstrap_template
      • PyRuntimeInfo.stub_shebang
      • PyRuntimeInfo.zip_main_template
  • //python/entry_points:py_console_script_binary.bzl
    • py_console_script_binary
  • //python/extensions:pip.bzl
    • pip
      • pip.override
      • pip.parse
      • pip.whl_mods
  • //python/extensions:python.bzl
    • python
      • python.override
      • python.single_version_override
      • python.single_version_platform_override
      • python.toolchain
  • //python
  • //python:packaging.bzl
    • py_package
    • py_wheel
    • py_wheel_dist
    • py_wheel_rule
    • PyWheelInfo
      • PyWheelInfo.<init>
      • PyWheelInfo.name_file
      • PyWheelInfo.wheel
  • //python:pip.bzl
    • compile_pip_requirements
    • multi_pip_parse
    • package_annotation
    • pip_parse
      • pip_parse.pip_utils.normalize_name
    • whl_filegroup
    • whl_library_alias
  • //python/private/api:py_common_api.bzl
    • py_common_api
    • PyCommonApi.merge_py_infos
    • PyCommonApi.PyInfoBuilder
  • //python/private:py_binary_rule.bzl
    • py_binary
  • //python/private:py_cc_toolchain_rule.bzl
    • py_cc_toolchain
  • //python/private:py_library_rule.bzl
    • py_library
  • //python/private:py_runtime_pair_rule.bzl
    • py_runtime_pair
  • //python/private:py_runtime_rule.bzl
    • py_runtime
  • //python/private:py_test_rule.bzl
    • py_test
  • //python:py_binary.bzl
    • py_binary
  • //python:py_cc_link_params_info.bzl
    • PyCcLinkParamsInfo
      • PyCcLinkParamsInfo.<init>
      • PyCcLinkParamsInfo.cc_info
  • //python:py_exec_tools_info.bzl
    • PyExecToolsInfo
      • PyExecToolsInfo.<init>
      • PyExecToolsInfo.exec_interpreter
      • PyExecToolsInfo.precompiler
  • //python:py_exec_tools_toolchain.bzl
    • py_exec_tools_toolchain
  • //python:py_executable_info.bzl
    • PyExecutableInfo
      • PyExecutableInfo.<init>
      • PyExecutableInfo.build_data_file
      • PyExecutableInfo.interpreter_path
      • PyExecutableInfo.main
      • PyExecutableInfo.runfiles_without_exe
  • //python:py_library.bzl
    • py_library
  • //python:py_runtime.bzl
    • py_runtime
  • //python:py_runtime_info.bzl
    • PyRuntimeInfo
      • PyRuntimeInfo.<init>
      • PyRuntimeInfo.abi_flags
      • PyRuntimeInfo.bootstrap_template
      • PyRuntimeInfo.coverage_files
      • PyRuntimeInfo.coverage_tool
      • PyRuntimeInfo.files
      • PyRuntimeInfo.implementation_name
      • PyRuntimeInfo.interpreter
      • PyRuntimeInfo.interpreter_path
      • PyRuntimeInfo.interpreter_version_info
      • PyRuntimeInfo.pyc_tag
      • PyRuntimeInfo.python_version
      • PyRuntimeInfo.site_init_template
      • PyRuntimeInfo.stage2_bootstrap_template
      • PyRuntimeInfo.stub_shebang
      • PyRuntimeInfo.zip_main_template
  • //python:py_test.bzl
    • py_test
  • //python:repositories.bzl
    • is_standalone_interpreter
    • py_repositories
    • python_register_multi_toolchains
    • python_register_toolchains
    • python_repository
  • //python/runtime_env_toolchains
  • //tools/precompiler
• sphinxdocs Bazel APIs
  • //sphinxdocs
  • //sphinxdocs/inventories
  • //sphinxdocs/private:sphinx_docs_library.bzl
    • sphinx_docs_library
  • //sphinxdocs:readthedocs.bzl
    • readthedocs_install
  • //sphinxdocs:sphinx.bzl
    • sphinx_build_binary
    • sphinx_docs
    • sphinx_inventory
    • sphinx_run
  • //sphinxdocs:sphinx_docs_library.bzl
    • sphinx_docs_library
  • //sphinxdocs:sphinx_stardoc.bzl
    • sphinx_stardoc
    • sphinx_stardocs