project-config
0.9
Quickstart
Installation
Basic usage
Examples
Tutorials
Reference
project-config CLI
Configuration
Styling
Plugins
Using on CI
In depth
Rationale
Fetching
Objects serialization
For developers
Writing third party plugins
Writing third party reporters
Changelog
Contributing
Reference
project-config
Index
Index
_
|
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
J
|
L
|
M
|
O
|
P
|
R
|
S
|
T
|
U
|
V
|
W
|
Y
|
Z
_
_abc_impl (project_config.compat.Protocol attribute)
(project_config.reporters.base.BaseColorReporter attribute)
(project_config.reporters.base.BaseFormattedReporter attribute)
(project_config.reporters.base.BaseNoopFormattedReporter attribute)
(project_config.reporters.base.BaseReporter attribute)
(project_config.reporters.default.BaseDefaultReporter attribute)
(project_config.reporters.default.DefaultColorReporter attribute)
(project_config.reporters.default.DefaultReporter attribute)
(project_config.reporters.ghf_markdown.GithubFlavoredMarkdownColorReporter attribute)
(project_config.reporters.ghf_markdown.GithubFlavoredMarkdownReporter attribute)
(project_config.reporters.json_.JsonColorReporter attribute)
(project_config.reporters.json_.JsonReporter attribute)
(project_config.reporters.table.TableColorReporter attribute)
(project_config.reporters.table.TableReporter attribute)
(project_config.reporters.toml.TomlColorReporter attribute)
(project_config.reporters.toml.TomlReporter attribute)
(project_config.reporters.yaml.YamlColorReporter attribute)
(project_config.reporters.yaml.YamlReporter attribute)
_add_new_rules_plugins_to_style() (project_config.config.style.Style method)
_add_plugin_to_cache() (project_config.plugins.Plugins method)
_build_github_api_url() (in module project_config.fetchers.github)
_build_hash() (in module project_config.utils.crypto)
_build_reverse_jmes_type_object() (in module project_config.utils.jmespath)
_cache_string_to_seconds() (in module project_config.config)
_check_files_absence() (project_config.commands.check.ProjectConfigChecker method)
_check_files_existence() (project_config.commands.check.ProjectConfigChecker method)
_common_generate_errors_report() (in module project_config.reporters.table)
(in module project_config.reporters.toml)
_common_generate_rows() (in module project_config.reporters.table)
_controlled_error() (in module project_config.__main__)
_create_find_function_for_string_or_array() (in module project_config.utils.jmespath)
_create_is_function_for_string() (in module project_config.utils.jmespath)
_create_just_function_for_string() (in module project_config.utils.jmespath)
_create_partition_function_for_string() (in module project_config.utils.jmespath)
_create_removeaffix_function_for_string() (in module project_config.utils.jmespath)
_create_simple_transform_function_for_string() (in module project_config.utils.jmespath)
_create_split_function_for_string() (in module project_config.utils.jmespath)
_create_strip_function_for_string() (in module project_config.utils.jmespath)
_directories_not_accepted_as_inputs_error() (in module project_config.plugins.inclusion)
_expiration_time (project_config.cache.Cache attribute)
_extend_partial_style() (project_config.config.style.Style method)
_file_can_not_be_serialized_as_object_error() (in module project_config.serializers)
_func_capitalize() (project_config.utils.jmespath.JMESPathProjectConfigFunctions method)
_func_casefold() (project_config.utils.jmespath.JMESPathProjectConfigFunctions method)
_func_center() (project_config.utils.jmespath.JMESPathProjectConfigFunctions method)
_func_count() (project_config.utils.jmespath.JMESPathProjectConfigFunctions method)
_func_deepmerge() (project_config.utils.jmespath.JMESPathProjectConfigFunctions method)
_func_ends_with() (project_config.utils.jmespath.JMESPathProjectConfigFunctions method)
_func_enumerate() (project_config.utils.jmespath.JMESPathProjectConfigFunctions method)
_func_exists() (project_config.utils.jmespath.JMESPathProjectConfigFunctions method)
_func_find() (project_config.utils.jmespath.JMESPathProjectConfigFunctions method)
_func_format() (project_config.utils.jmespath.JMESPathProjectConfigFunctions method)
_func_from_items() (project_config.utils.jmespath.JMESPathProjectConfigFunctions method)
_func_getenv() (project_config.utils.jmespath.JMESPathProjectConfigFunctions method)
_func_gh_tags() (project_config.utils.jmespath.JMESPathProjectConfigFunctions method)
_func_glob() (project_config.utils.jmespath.JMESPathProjectConfigFunctions method)
_func_insert() (project_config.utils.jmespath.JMESPathProjectConfigFunctions method)
_func_isalnum() (project_config.utils.jmespath.JMESPathProjectConfigFunctions method)
_func_isalpha() (project_config.utils.jmespath.JMESPathProjectConfigFunctions method)
_func_isascii() (project_config.utils.jmespath.JMESPathProjectConfigFunctions method)
_func_isdecimal() (project_config.utils.jmespath.JMESPathProjectConfigFunctions method)
_func_isdigit() (project_config.utils.jmespath.JMESPathProjectConfigFunctions method)
_func_isdir() (project_config.utils.jmespath.JMESPathProjectConfigFunctions method)
_func_isfile() (project_config.utils.jmespath.JMESPathProjectConfigFunctions method)
_func_isidentifier() (project_config.utils.jmespath.JMESPathProjectConfigFunctions method)
_func_islower() (project_config.utils.jmespath.JMESPathProjectConfigFunctions method)
_func_isnumeric() (project_config.utils.jmespath.JMESPathProjectConfigFunctions method)
_func_isprintable() (project_config.utils.jmespath.JMESPathProjectConfigFunctions method)
_func_isspace() (project_config.utils.jmespath.JMESPathProjectConfigFunctions method)
_func_istitle() (project_config.utils.jmespath.JMESPathProjectConfigFunctions method)
_func_isupper() (project_config.utils.jmespath.JMESPathProjectConfigFunctions method)
_func_listdir() (project_config.utils.jmespath.JMESPathProjectConfigFunctions method)
_func_ljust() (project_config.utils.jmespath.JMESPathProjectConfigFunctions method)
_func_lower() (project_config.utils.jmespath.JMESPathProjectConfigFunctions method)
_func_lstrip() (project_config.utils.jmespath.JMESPathProjectConfigFunctions method)
_func_mkdir() (project_config.utils.jmespath.JMESPathProjectConfigFunctions method)
_func_op() (project_config.utils.jmespath.JMESPathProjectConfigFunctions method)
_func_os() (project_config.utils.jmespath.JMESPathProjectConfigFunctions method)
_func_partition() (project_config.utils.jmespath.JMESPathProjectConfigFunctions method)
_func_range() (project_config.utils.jmespath.JMESPathProjectConfigFunctions method)
_func_regex_escape() (project_config.utils.jmespath.JMESPathProjectConfigFunctions method)
_func_regex_match() (project_config.utils.jmespath.JMESPathProjectConfigFunctions method)
_func_regex_matchall() (project_config.utils.jmespath.JMESPathProjectConfigFunctions method)
_func_regex_search() (project_config.utils.jmespath.JMESPathProjectConfigFunctions method)
_func_regex_sub() (project_config.utils.jmespath.JMESPathProjectConfigFunctions method)
_func_removeprefix() (project_config.utils.jmespath.JMESPathProjectConfigFunctions method)
_func_removesuffix() (project_config.utils.jmespath.JMESPathProjectConfigFunctions method)
_func_replace() (project_config.utils.jmespath.JMESPathProjectConfigFunctions method)
_func_rfind() (project_config.utils.jmespath.JMESPathProjectConfigFunctions method)
_func_rjust() (project_config.utils.jmespath.JMESPathProjectConfigFunctions method)
_func_rmdir() (project_config.utils.jmespath.JMESPathProjectConfigFunctions method)
_func_rootdir_name() (project_config.utils.jmespath.JMESPathProjectConfigFunctions method)
_func_round() (project_config.utils.jmespath.JMESPathProjectConfigFunctions method)
_func_rpartition() (project_config.utils.jmespath.JMESPathProjectConfigFunctions method)
_func_rsplit() (project_config.utils.jmespath.JMESPathProjectConfigFunctions method)
_func_rstrip() (project_config.utils.jmespath.JMESPathProjectConfigFunctions method)
_func_set() (project_config.utils.jmespath.JMESPathProjectConfigFunctions method)
_func_setenv() (project_config.utils.jmespath.JMESPathProjectConfigFunctions method)
_func_shlex_join() (project_config.utils.jmespath.JMESPathProjectConfigFunctions method)
_func_shlex_split() (project_config.utils.jmespath.JMESPathProjectConfigFunctions method)
_func_split() (project_config.utils.jmespath.JMESPathProjectConfigFunctions method)
_func_splitlines() (project_config.utils.jmespath.JMESPathProjectConfigFunctions method)
_func_starts_with() (project_config.utils.jmespath.JMESPathProjectConfigFunctions method)
_func_strip() (project_config.utils.jmespath.JMESPathProjectConfigFunctions method)
_func_swapcase() (project_config.utils.jmespath.JMESPathProjectConfigFunctions method)
_func_title() (project_config.utils.jmespath.JMESPathProjectConfigFunctions method)
_func_to_items() (project_config.utils.jmespath.JMESPathProjectConfigFunctions method)
_func_unset() (project_config.utils.jmespath.JMESPathProjectConfigFunctions method)
_func_update() (project_config.utils.jmespath.JMESPathProjectConfigFunctions method)
_func_upper() (project_config.utils.jmespath.JMESPathProjectConfigFunctions method)
_func_zfill() (project_config.utils.jmespath.JMESPathProjectConfigFunctions method)
_GET_impl() (in module project_config.utils.http)
_get_scheme_from_urlparts() (in module project_config.fetchers)
_get_serializer_function() (in module project_config.serializers)
_github_headers() (in module project_config.fetchers.github)
_identify_serializer() (in module project_config.serializers)
_is_protocol (project_config.compat.Protocol attribute)
_is_runtime_protocol (project_config.compat.Protocol attribute)
_load_styles_from_config() (project_config.config.style.Style method)
_normalize_colors() (project_config.reporters.base.BaseColorReporter method)
_normalize_indentation_to_2_spaces() (in module project_config.reporters.toml)
_parse_command_args() (in module project_config.__main__)
_parse_reporter_arguments() (in module project_config.reporters)
_prefetch_urls() (in module project_config.config.style)
_prepare_all_plugins_cache() (project_config.plugins.Plugins method)
_prepare_default_plugins_cache() (project_config.plugins.Plugins method)
_prepare_third_party_reporters() (project_config.reporters.ThirdPartyReporters method)
_process_conditionals_for_rule() (project_config.commands.check.ProjectConfigChecker method)
_pyobject_to_ini_str() (in module project_config.serializers.editorconfig)
_pyobject_to_string() (in module project_config.serializers.python)
_replace_nulls_by_repr_strings_in_dict() (in module project_config.reporters.toml)
_run_check() (project_config.commands.check.ProjectConfigChecker method)
_to_items() (in module project_config.utils.jmespath)
_transform_config_data() (project_config.reporters.yaml.YamlColorReporter method)
_transform_errors() (project_config.reporters.yaml.YamlColorReporter method)
_transform_plugins_data() (project_config.reporters.yaml.YamlColorReporter method)
_transform_style_data() (project_config.reporters.yaml.YamlColorReporter method)
_validate_cli_config() (in module project_config.config)
_validate_style_preparing_new_plugins() (project_config.config.style.Style method)
A
AcceptHeader (class in project_config.fetchers.github)
action()
built-in function
ActionsContext (class in project_config)
(class in project_config.types_)
assert_data_report() (in module project_config.tests.pytest_plugin.plugin)
assert_errors_report() (in module project_config.tests.pytest_plugin.plugin)
assert_expected_files() (in module project_config.tests.pytest_plugin.helpers)
assert_project_config_plugin_action() (in module project_config.tests.pytest_plugin.plugin)
B
BaseColorReporter (class in project_config.reporters.base)
BaseDefaultReporter (class in project_config.reporters.default)
BaseFormattedReporter (class in project_config.reporters.base)
BaseNoopFormattedReporter (class in project_config.reporters.base)
BaseReporter (class in project_config.reporters.base)
bold_color() (in module project_config.reporters.base)
build_main_parser() (in module project_config.__main__)
built-in function
action()
capitalize()
casefold()
center()
count()
deepmerge()
ends_with()
enumerate()
exists()
find()
format()
from_items()
getenv()
gh_tags()
glob()
insert()
isalnum()
isalpha()
isascii()
isdecimal()
isdigit()
isdir()
isfile()
isidentifier()
islower()
isnumeric()
isprintable()
isspace()
istitle()
isupper()
listdir()
ljust()
lower()
lstrip()
mkdir()
op()
os()
partition()
range()
regex_escape()
regex_match()
regex_matchall()
regex_search()
regex_sub()
removeprefix()
removesuffix()
replace()
rfind()
rjust()
rmdir()
rootdir_name()
round()
rpartition()
rsplit()
rstrip()
set()
setenv()
shlex_join()
shlex_split()
split()
splitlines()
starts_with()
strip()
swapcase()
title()
to_items()
unset()
update()
upper()
zfill()
C
Cache (class in project_config.cache)
cache_file() (in module project_config.tree)
cached_function() (in module project_config.compat)
cached_local_file() (in module project_config.tree)
capitalize()
built-in function
casefold()
built-in function
center()
built-in function
check() (in module project_config.commands.check)
clean() (in module project_config.commands.clean)
(project_config.cache.Cache static method)
colored_color_exists() (in module project_config.reporters.base)
compile_JMESPath_expression() (in module project_config.utils.jmespath)
compile_JMESPath_expression_or_error() (in module project_config.utils.jmespath)
compile_JMESPath_or_expected_value_error() (in module project_config.utils.jmespath)
compile_JMESPath_or_expected_value_from_other_file_error() (in module project_config.utils.jmespath)
ConditionalsFalseResult
Config (class in project_config.config)
config_docs_markdown_link() (in module project_config.reporters.ghf_markdown)
config_docs_url_prefix() (in module project_config.reporters.ghf_markdown)
ConfigurationFilesNotFound
count()
built-in function
create_files() (in module project_config.tests.pytest_plugin.helpers)
create_tree() (in module project_config.tests.pytest_plugin.helpers)
crossJMESPathsMatch() (project_config.plugins.jmespath.JMESPathPlugin static method)
CustomConfigFileNotFound
D
data (project_config.reporters.base.BaseReporter attribute)
deepmerge()
built-in function
DefaultColorReporter (class in project_config.reporters.default)
DefaultReporter (class in project_config.reporters.default)
deserialize_for_url() (in module project_config.serializers)
download_file_from_urlsplit_scheme() (in module project_config.fetchers)
dumps() (in module project_config.serializers.contrib.pre_commit)
(in module project_config.serializers.editorconfig)
(in module project_config.serializers.ini)
(in module project_config.serializers.json)
(in module project_config.serializers.python)
(in module project_config.serializers.text)
(in module project_config.serializers.yaml)
E
edit_local_file() (in module project_config.tree)
ends_with()
built-in function
ensure_dir() (project_config.cache.Cache class method)
enumerate()
built-in function
errors (project_config.reporters.base.BaseReporter attribute)
evaluate_JMESPath() (in module project_config.utils.jmespath)
evaluate_JMESPath_or_expected_value_error() (in module project_config.utils.jmespath)
exception_class (project_config.reporters.base.BaseReporter attribute)
excludeContent() (project_config.plugins.inclusion.InclusionPlugin static method)
excludeLines() (project_config.plugins.inclusion.InclusionPlugin static method)
ExistencePlugin (class in project_config.plugins.existence)
exists()
built-in function
F
fetch() (in module project_config.fetchers)
(in module project_config.fetchers.file)
(in module project_config.fetchers.github)
(in module project_config.fetchers.https)
fetch_remote_file() (in module project_config.tree)
FetchError
FileConfig (class in project_config.config)
files (project_config.ActionsContext attribute)
(project_config.types_.ActionsContext attribute)
find()
built-in function
fix (project_config.ActionsContext attribute)
(project_config.types_.ActionsContext attribute)
fix_tree_serialized_file_by_jmespath() (in module project_config.utils.jmespath)
format (project_config.reporters.base.BaseReporter attribute)
format()
built-in function
format_config_key() (project_config.reporters.base.BaseColorReporter method)
(project_config.reporters.base.BaseFormattedReporter method)
(project_config.reporters.base.BaseNoopFormattedReporter method)
format_config_value() (project_config.reporters.base.BaseColorReporter method)
(project_config.reporters.base.BaseFormattedReporter method)
(project_config.reporters.base.BaseNoopFormattedReporter method)
format_definition() (project_config.reporters.base.BaseColorReporter method)
(project_config.reporters.base.BaseFormattedReporter method)
(project_config.reporters.base.BaseNoopFormattedReporter method)
format_error_message() (project_config.reporters.base.BaseColorReporter method)
(project_config.reporters.base.BaseFormattedReporter method)
(project_config.reporters.base.BaseNoopFormattedReporter method)
format_file() (project_config.reporters.base.BaseColorReporter method)
(project_config.reporters.base.BaseFormattedReporter method)
(project_config.reporters.base.BaseNoopFormattedReporter method)
format_fixed() (project_config.reporters.base.BaseColorReporter method)
(project_config.reporters.base.BaseFormattedReporter method)
(project_config.reporters.base.BaseNoopFormattedReporter method)
format_hint() (project_config.reporters.base.BaseColorReporter method)
(project_config.reporters.base.BaseFormattedReporter method)
(project_config.reporters.base.BaseNoopFormattedReporter method)
format_key() (project_config.reporters.base.BaseColorReporter method)
(project_config.reporters.base.BaseFormattedReporter method)
(project_config.reporters.base.BaseNoopFormattedReporter method)
format_metachar() (project_config.reporters.base.BaseColorReporter method)
(project_config.reporters.base.BaseFormattedReporter method)
(project_config.reporters.base.BaseNoopFormattedReporter method)
from_config() (project_config.config.style.Style class method)
from_items()
built-in function
FUNCTION_TABLE (project_config.utils.jmespath.JMESPathProjectConfigFunctions attribute)
G
generate_data_report() (project_config.reporters.base.BaseReporter method)
(project_config.reporters.default.BaseDefaultReporter method)
(project_config.reporters.ghf_markdown.GithubFlavoredMarkdownReporter method)
(project_config.reporters.json_.JsonColorReporter method)
(project_config.reporters.json_.JsonReporter method)
(project_config.reporters.toml.TomlColorReporter method)
(project_config.reporters.toml.TomlReporter method)
(project_config.reporters.yaml.YamlColorReporter method)
(project_config.reporters.yaml.YamlReporter method)
generate_errors_report() (project_config.reporters.base.BaseReporter method)
(project_config.reporters.default.BaseDefaultReporter method)
(project_config.reporters.ghf_markdown.GithubFlavoredMarkdownReporter method)
(project_config.reporters.json_.JsonColorReporter method)
(project_config.reporters.json_.JsonReporter method)
(project_config.reporters.table.TableColorReporter method)
(project_config.reporters.table.TableReporter method)
(project_config.reporters.toml.TomlColorReporter method)
(project_config.reporters.toml.TomlReporter method)
(project_config.reporters.yaml.YamlColorReporter method)
(project_config.reporters.yaml.YamlReporter method)
generate_possible_cache_dirs() (in module project_config.cache)
generate_unique_key_from_tree_entry() (project_config.cache.Cache class method)
GET() (in module project_config.utils.http)
get() (project_config.cache.Cache class method)
get_creation_time_from_fpath() (in module project_config.cache)
get_function_for_action() (project_config.plugins.Plugins method)
get_latest_release_tags() (in module project_config.fetchers.github)
get_reporter() (in module project_config.reporters)
get_reporter_class_from_module() (in module project_config.tests.pytest_plugin.helpers)
getenv()
built-in function
gh_tags()
built-in function
GithubFlavoredMarkdownColorReporter (class in project_config.reporters.ghf_markdown)
GithubFlavoredMarkdownReporter (class in project_config.reporters.ghf_markdown)
glob()
built-in function
guess_preferred_serializer() (in module project_config.serializers)
guess_serializer_for_path() (in module project_config.serializers)
H
hash_file() (in module project_config.utils.crypto)
hash_hexdigest() (in module project_config.utils.crypto)
I
ids (project_config.reporters.ThirdPartyReporters property)
ifFilesExist() (project_config.plugins.existence.ExistencePlugin static method)
ifIncludeLines() (project_config.plugins.inclusion.InclusionPlugin static method)
ifJMESPathsMatch() (project_config.plugins.jmespath.JMESPathPlugin static method)
includeContent() (project_config.plugins.inclusion.InclusionPlugin static method)
includeLines() (project_config.plugins.inclusion.InclusionPlugin static method)
InclusionPlugin (class in project_config.plugins.inclusion)
init() (in module project_config.commands.init)
initialize_config() (in module project_config.config)
insert()
built-in function
instance (project_config.reporters.ThirdPartyReporters attribute)
InterruptCheck
InvalidColors
InvalidNotBasedThirdPartyReporter
InvalidPluginFunction
InvalidThirdPartyReporterName
InvalidThirdPartyReportersModule
is_literal_jmespath_expression() (in module project_config.utils.jmespath)
is_valid_action() (project_config.plugins.Plugins method)
isalnum()
built-in function
isalpha()
built-in function
isascii()
built-in function
isdecimal()
built-in function
isdigit()
built-in function
isdir()
built-in function
isfile()
built-in function
isidentifier()
built-in function
islower()
built-in function
isnumeric()
built-in function
isprintable()
built-in function
isspace()
built-in function
istitle()
built-in function
isupper()
built-in function
J
JMESPathError
JMESPathPlugin (class in project_config.plugins.jmespath)
JMESPathProjectConfigFunctions (class in project_config.utils.jmespath)
JMESPathsMatch() (project_config.plugins.jmespath.JMESPathPlugin static method)
JSON (project_config.fetchers.github.AcceptHeader attribute)
JsonColorReporter (class in project_config.reporters.json_)
JsonReporter (class in project_config.reporters.json_)
L
listdir()
built-in function
ljust()
built-in function
load() (project_config.reporters.ThirdPartyReporters method)
load_style() (project_config.config.FileConfig method)
loads() (in module project_config.serializers.editorconfig)
(in module project_config.serializers.ini)
(in module project_config.serializers.python)
(in module project_config.serializers.text)
(in module project_config.serializers.toml)
(in module project_config.serializers.yaml)
lower()
built-in function
lstrip()
built-in function
M
main() (in module project_config.__main__)
maybe_write_report_to_github_summary() (in module project_config.reporters.ghf_markdown)
message (project_config.exceptions.ProjectConfigException attribute)
mkdir()
built-in function
module
project_config
project_config.__main__
project_config.cache
project_config.commands
project_config.commands.check
project_config.commands.clean
project_config.commands.fix
project_config.commands.init
project_config.commands.show
project_config.compat
project_config.config
project_config.config.exceptions
project_config.config.style
project_config.constants
project_config.exceptions
project_config.fetchers
project_config.fetchers.file
project_config.fetchers.github
project_config.fetchers.https
project_config.plugins
project_config.plugins.contrib
project_config.plugins.contrib.pre_commit
project_config.plugins.existence
project_config.plugins.inclusion
project_config.plugins.jmespath
project_config.reporters
project_config.reporters.base
project_config.reporters.default
project_config.reporters.ghf_markdown
project_config.reporters.json_
project_config.reporters.table
project_config.reporters.toml
project_config.reporters.yaml
project_config.serializers
project_config.serializers.contrib
project_config.serializers.contrib.pre_commit
project_config.serializers.editorconfig
project_config.serializers.ini
project_config.serializers.json
project_config.serializers.python
project_config.serializers.text
project_config.serializers.toml
project_config.serializers.yaml
project_config.tests
project_config.tests.pytest_plugin
project_config.tests.pytest_plugin.helpers
project_config.tests.pytest_plugin.plugin
project_config.tree
project_config.types_
project_config.utils
project_config.utils.crypto
project_config.utils.http
project_config.utils.jmespath
O
only_hints (project_config.reporters.base.BaseReporter attribute)
op()
built-in function
os()
built-in function
P
parse_args() (in module project_config.__main__)
parse_cli_args_and_subargs() (in module project_config.__main__)
parse_reporter_id() (in module project_config.reporters)
partition()
built-in function
plugin_action_names (project_config.plugins.Plugins property)
plugin_names (project_config.plugins.Plugins property)
plugin_or_verb_docs_url_prefix() (in module project_config.reporters.ghf_markdown)
Plugins (class in project_config.plugins)
preCommitHookExists() (project_config.plugins.contrib.pre_commit.PreCommitPlugin static method)
PreCommitPlugin (class in project_config.plugins.contrib.pre_commit)
prepare_3rd_party_plugin() (project_config.plugins.Plugins method)
project_config
module
project_config.__main__
module
project_config.cache
module
project_config.commands
module
project_config.commands.check
module
project_config.commands.clean
module
project_config.commands.fix
module
project_config.commands.init
module
project_config.commands.show
module
project_config.compat
module
project_config.config
module
project_config.config.exceptions
module
project_config.config.style
module
project_config.constants
module
project_config.exceptions
module
project_config.fetchers
module
project_config.fetchers.file
module
project_config.fetchers.github
module
project_config.fetchers.https
module
project_config.plugins
module
project_config.plugins.contrib
module
project_config.plugins.contrib.pre_commit
module
project_config.plugins.existence
module
project_config.plugins.inclusion
module
project_config.plugins.jmespath
module
project_config.reporters
module
project_config.reporters.base
module
project_config.reporters.default
module
project_config.reporters.ghf_markdown
module
project_config.reporters.json_
module
project_config.reporters.table
module
project_config.reporters.toml
module
project_config.reporters.yaml
module
project_config.serializers
module
project_config.serializers.contrib
module
project_config.serializers.contrib.pre_commit
module
project_config.serializers.editorconfig
module
project_config.serializers.ini
module
project_config.serializers.json
module
project_config.serializers.python
module
project_config.serializers.text
module
project_config.serializers.toml
module
project_config.serializers.yaml
module
project_config.tests
module
project_config.tests.pytest_plugin
module
project_config.tests.pytest_plugin.helpers
module
project_config.tests.pytest_plugin.plugin
module
project_config.tree
module
project_config.types_
module
project_config.utils
module
project_config.utils.crypto
module
project_config.utils.http
module
project_config.utils.jmespath
module
project_config_data_report_asserter() (in module project_config.tests.pytest_plugin)
(in module project_config.tests.pytest_plugin.plugin)
project_config_errors_report_asserter() (in module project_config.tests.pytest_plugin)
(in module project_config.tests.pytest_plugin.plugin)
project_config_plugin_action_asserter() (in module project_config.tests.pytest_plugin)
(in module project_config.tests.pytest_plugin.plugin)
ProjectConfigAlreadyInitialized
ProjectConfigChecker (class in project_config.commands.check)
ProjectConfigCheckFailed
ProjectConfigException
ProjectConfigHTTPError
ProjectConfigInvalidConfig
ProjectConfigInvalidConfigSchema
ProjectConfigInvalidStyle
ProjectConfigNotImplementedError
ProjectConfigTimeoutError
Protocol (class in project_config.compat)
PyprojectTomlFoundButHasNoConfig
R
raise_errors() (project_config.reporters.base.BaseReporter method)
(project_config.reporters.ghf_markdown.GithubFlavoredMarkdownReporter method)
range()
built-in function
read_config() (in module project_config.config)
read_config_from_pyproject_toml() (in module project_config.config)
read_file() (in module project_config.cache)
regex_escape()
built-in function
regex_match()
built-in function
regex_matchall()
built-in function
regex_search()
built-in function
regex_sub()
built-in function
removeprefix()
built-in function
removeprefix() (in module project_config.compat)
(in module project_config.utils.jmespath)
removesuffix()
built-in function
removesuffix() (in module project_config.compat)
(in module project_config.utils.jmespath)
replace()
built-in function
report_error() (project_config.reporters.base.BaseReporter method)
reporter_from_config() (in module project_config.config)
ReporterAction (class in project_config.__main__)
resolve_maybe_relative_url() (in module project_config.fetchers)
resolve_url() (in module project_config.fetchers)
(in module project_config.fetchers.github)
rfind()
built-in function
rjust()
built-in function
rmdir()
built-in function
rootdir (project_config.reporters.base.BaseReporter attribute)
rootdir_name()
built-in function
round()
built-in function
rpartition()
built-in function
rsplit()
built-in function
rstrip()
built-in function
run() (in module project_config.__main__)
(project_config.commands.check.ProjectConfigChecker method)
S
SchemeProtocolNotImplementedError
self_format_noop() (in module project_config.reporters.base)
serialize_for_url() (in module project_config.serializers)
SerializerError
set()
built-in function
set() (project_config.cache.Cache class method)
set_expiration_time() (project_config.cache.Cache class method)
setenv()
built-in function
shlex_join()
built-in function
shlex_split()
built-in function
show() (in module project_config.commands.show)
smart_fixer_by_expected_value() (in module project_config.utils.jmespath)
sort_pre_commit_config() (in module project_config.serializers.contrib.pre_commit)
split()
built-in function
splitlines()
built-in function
starts_with()
built-in function
strip()
built-in function
Style (class in project_config.config.style)
styling_docs_url_prefix() (in module project_config.reporters.ghf_markdown)
success (project_config.reporters.base.BaseReporter property)
swapcase()
built-in function
T
TableColorReporter (class in project_config.reporters.table)
TableReporter (class in project_config.reporters.table)
ThirdPartyReporters (class in project_config.reporters)
title()
built-in function
to_items()
built-in function
TomlColorReporter (class in project_config.reporters.toml)
TomlReporter (class in project_config.reporters.toml)
TypedDict() (in module project_config.compat)
U
UnparseableReporterError
unset()
built-in function
update()
built-in function
upper()
built-in function
uri_is_pointing_to_local_file() (in module project_config.fetchers)
urlsplit_with_scheme() (in module project_config.fetchers)
V
validate_cli_config() (in module project_config.config)
validate_config() (in module project_config.config)
validate_config_cache() (in module project_config.config)
validate_config_style() (in module project_config.config)
validate_reporter_class() (project_config.reporters.ThirdPartyReporters method)
validate_reporter_module() (project_config.reporters.ThirdPartyReporters method)
W
write_file() (in module project_config.cache)
Y
YamlColorReporter (class in project_config.reporters.yaml)
YamlReporter (class in project_config.reporters.yaml)
Z
zfill()
built-in function