pkgcheck.checks package¶
Submodules¶
- pkgcheck.checks.acct module
- pkgcheck.checks.cleanup module
- pkgcheck.checks.codingstyle module
AbsoluteSymlinkAbsoluteSymlinkCheckBadCommandsCheckBannedEapiCommandBannedPhaseCallBetterCompressionCheckBetterCompressionUriDeclarationShadowedCheckDeprecatedEapiCommandDeprecatedInsintoDoCompressedFilesCheckDoublePrefixInPathDuplicateFunctionDefinitionEbuildUnquotedVariableEbuildUnquotedVariablesCheckEbuildVariableScopeEclassUnquotedVariableEclassUnquotedVariablesCheckEendMissingArgEendMissingArgCheckEmptyGlobalAssignmentExcessiveLineLengthGlobCheckGlobDistdirHomepageInSrcUriIndirectInheritsInheritsCheckInsintoCheckInstallCompressedInfoInstallCompressedManpageInternalEclassUsageInvalidSandboxCallLineLengthCheckMetadataVarCheckMissingInheritsMissingSlashMultipleKeywordsLinesNonConsistentTarUsageNonPosixCheckNonPosixHeadTailUsageObsoleteUriObsoleteUriCheckPathVariablesCheckReadonlyVariableReadonlyVariableCheckRedundantDodirRedundantDodirCheckReferenceInMetadataVarSandboxCallCheckSelfAssignmentStaticSrcUriUnnecessarySlashStripUnquotedVariableUnusedInheritsVariableOrderCheckVariableOrderWrongVariableScopeVariableScopeCheckVariableShadowedverify_vars()
- pkgcheck.checks.dropped_keywords module
- pkgcheck.checks.eclass module
DeprecatedEclassDeprecatedEclassFunctionDeprecatedEclassVariableDuplicateEclassInheritEclassBashSyntaxErrorEclassCheckEclassDocErrorEclassDocMissingFuncEclassDocMissingVarEclassExportFuncsBeforeInheritEclassManualDepsCheckEclassParseCheckEclassUsageCheckEclassUsageCheck.check_deprecated_functions()EclassUsageCheck.check_deprecated_variables()EclassUsageCheck.check_pre_inherits()EclassUsageCheck.check_provided_eclasses()EclassUsageCheck.check_user_variables()EclassUsageCheck.feed()EclassUsageCheck.known_resultsEclassUsageCheck.required_addonsEclassUsageCheck.scope
EclassUserVariableUsageEclassVariableScopeGoMissingDepsMisplacedEclassVarProvidedEclassInheritRubyMissingDepsRustMissingDepsTmpfilesMissingDeps
- pkgcheck.checks.git module
BadCommitSummaryDirectNoMaintainerDirectStableKeywordsDroppedStableKeywordsDroppedUnstableKeywordsEAPIChangeWithoutRevbumpEbuildIncorrectCopyrightEclassIncorrectCopyrightGitCommitMessageCheckGitCommitsRepoSourceGitCommitsSourceGitEclassCommitsCheckGitPkgCommitsCheckGitPkgCommitsCheck.added_repoGitPkgCommitsCheck.addition_checks()GitPkgCommitsCheck.allowed_direct_stableGitPkgCommitsCheck.cleanup()GitPkgCommitsCheck.env_array_elem_regexGitPkgCommitsCheck.feed()GitPkgCommitsCheck.known_resultsGitPkgCommitsCheck.modified_checks()GitPkgCommitsCheck.modified_repoGitPkgCommitsCheck.python_compat_declare_regexGitPkgCommitsCheck.python_pep517_regexGitPkgCommitsCheck.removal_checks()GitPkgCommitsCheck.removal_repoGitPkgCommitsCheck.rename_checks()GitPkgCommitsCheck.required_addonsGitPkgCommitsCheck.scopeGitPkgCommitsCheck.src_uri_changes()
IncorrectCopyrightInvalidCommitMessageInvalidCommitTagMissingMoveMissingSignOffMissingSlotmoveNewerEAPIAvailableOldPythonCompatPythonPEP517WithoutRevbumpRdependChangeSrcUriChecksumChangeSuspiciousSrcUriChangeverify_tags()
- pkgcheck.checks.glsa module
- pkgcheck.checks.header module
EbuildHeaderCheckEbuildInvalidCopyrightEbuildInvalidLicenseHeaderEbuildNonGentooAuthorsCopyrightEbuildOldGentooCopyrightEclassHeaderCheckEclassInvalidCopyrightEclassInvalidLicenseHeaderEclassNonGentooAuthorsCopyrightEclassOldGentooCopyrightInvalidCopyrightInvalidLicenseHeaderNonGentooAuthorsCopyrightOldGentooCopyright
- pkgcheck.checks.imlate module
- pkgcheck.checks.metadata module
BadDefaultUseFlagsBadDependencyBadDescriptionBadFilenameBadHomepageBadKeywordsBadProtocolBannedEapiDependencyCheckDeprecatedDepDeprecatedEapiDeprecatedLicenseDescriptionCheckDuplicateKeywordsEapiCheckHomepageCheckInvalidBdependInvalidDependInvalidEapiInvalidIdependInvalidLicenseInvalidPdependInvalidPropertiesInvalidRdependInvalidRequiredUseInvalidRestrictInvalidSlotInvalidSrcUriInvalidUseFlagsIuseCheckKeywordsCheckLicenseCheckLocalUseCheckMatchingGlobalUseMisplacedWeakBlockerMissingLicenseMissingLicenseRestrictsMissingLocalUseDescMissingPackageRevisionMissingSlotDepMissingSlotDepCheckMissingTestRestrictMissingUnpackerDepMissingUnpackerDepCheckMissingUriMissingUseDepDefaultNonexistentBlockerOutdatedBlockerOutdatedBlockersCheckOverlappingKeywordsProbableGlobalUseProbableUseExpandPropertiesCheckRedundantUriRenameRequiredUseCheckRequiredUseDefaultsRestrictCheckRestrictTestCheckSourcingCheckSourcingErrorSrcUriCheckSrcUriFilenameDotPrefixStableKeywordsOnTestingEapiStaleLiveCheckStaleLiveEAPITarballAvailableUnderscoreInUseFlagUnknownKeywordsUnknownLicenseUnknownMirrorUnknownPropertiesUnknownRestrictUnknownUseFlagsUnnecessaryLicenseUnsortedKeywordsUnstableSrcUriUnsupportedEclassEapiUnusedLocalUseUseFlagWithoutDepsUseFlagsWithoutEffectsCheckVirtualKeywordsUpdateVirtualProvidersCheckVirtualWithBdependVirtualWithDependVirtualWithSingleProvider
- pkgcheck.checks.metadata_xml module
CatBadlyFormedXmlCatInvalidXmlCatMetadataXmlEmptyElementCatMetadataXmlIndentationCatMetadataXmlInvalidCatRefCatMetadataXmlInvalidPkgRefCatMissingMetadataXmlCategoryMetadataXmlCheckCategoryMetadataXmlCheck.catref_errorCategoryMetadataXmlCheck.empty_elementCategoryMetadataXmlCheck.indent_errorCategoryMetadataXmlCheck.invalid_errorCategoryMetadataXmlCheck.known_resultsCategoryMetadataXmlCheck.misformed_errorCategoryMetadataXmlCheck.missing_errorCategoryMetadataXmlCheck.pkgref_errorCategoryMetadataXmlCheck.scope
InvalidMetadataRestrictInvalidRemoteIDMaintainerNeededMaintainerWithoutProxyMissingRemoteIdMissingRemoteIdCheckNonexistentProjectMaintainerPackageMetadataXmlCheckPackageMetadataXmlCheck.catref_errorPackageMetadataXmlCheck.empty_elementPackageMetadataXmlCheck.indent_errorPackageMetadataXmlCheck.invalid_errorPackageMetadataXmlCheck.known_resultsPackageMetadataXmlCheck.misformed_errorPackageMetadataXmlCheck.missing_errorPackageMetadataXmlCheck.pkgref_errorPackageMetadataXmlCheck.remote_id_validatorsPackageMetadataXmlCheck.scope
PkgBadlyFormedXmlPkgInvalidXmlPkgMetadataXmlEmptyElementPkgMetadataXmlIndentationPkgMetadataXmlInvalidCatRefPkgMetadataXmlInvalidPkgRefPkgMissingMetadataXmlProxyWithoutProxiedRedundantLongDescriptionWrongMaintainerType
- pkgcheck.checks.network module
- pkgcheck.checks.overlays module
- pkgcheck.checks.perl module
- pkgcheck.checks.pkgdir module
- pkgcheck.checks.profiles module
ArchesOutOfSyncArchesWithoutProfilesBannedProfileEapiDeprecatedProfileEapiLaggingProfileEapiNonexistentCategoriesNonexistentProfilePathOutdatedProfilePackageProfileErrorProfileMissingImplicitExpandValuesProfileWarningProfilesCheckRepoProfilesCheckSystemSetMissingKeywordsUnknownCategoryDirsUnknownProfileArchUnknownProfilePackageUnknownProfilePackageKeywordsUnknownProfilePackageUseUnknownProfileUseUnknownProfileUseExpandUnknownProfileUseExpandValueUnmatchedProfilePackageUnmaskUnusedProfileDirsdir_parents()verify_files()
- pkgcheck.checks.python module
DistutilsNonPEP517BuildEPyTestPluginsSuggestionMisplacedEPyTestVarMissingPythonEclassPythonAnyMismatchedDepHasVersionCheckPythonAnyMismatchedUseHasVersionCheckPythonCheckPythonCheck.build_python_gen_any_dep_calls()PythonCheck.check_depend()PythonCheck.check_epytest_vars()PythonCheck.check_pep517()PythonCheck.check_python_check_deps()PythonCheck.check_required_use()PythonCheck.eclass_any_dep_funcPythonCheck.feed()PythonCheck.has_version_defaultPythonCheck.has_version_known_flagsPythonCheck.known_resultsPythonCheck.report_mismatch_check_deps()PythonCheck.scan_tree_recursively()PythonCheck.scopePythonCheck.setuptools_scm
PythonCompatCheckPythonCompatUpdatePythonEclassErrorPythonFetchableCheckPythonFetchableCheck.check_gh_suffix()PythonFetchableCheck.check_pypi_mirror()PythonFetchableCheck.feed()PythonFetchableCheck.known_resultsPythonFetchableCheck.normalize_distribution_name()PythonFetchableCheck.required_addonsPythonFetchableCheck.scopePythonFetchableCheck.simplify_pn_pv()PythonFetchableCheck.translate_version()
PythonGHDistfileSuffixPythonHasVersionMissingPythonUseDepPythonHasVersionUsagePythonInlinePyPIURIPythonMismatchedPackageNamePythonMissingDepsPythonMissingRequiredUsePythonMissingSCMDependencyPythonPackageNameCheckPythonRuntimeDepInAnyR1RedundantPyTestDisablePluginAutoloadShadowedEPyTestTimeoutget_python_eclass()is_python_interpreter()
- pkgcheck.checks.repo module
- pkgcheck.checks.repo_metadata module
BadPackageUpdateConflictingChksumsDeprecatedChksumDeprecatedManifestHashDeprecatedRepoHashEmptyProjectGlobalUseCheckInvalidManifestLicenseGroupsCheckManifestCheckManifestCollisionCheckMatchingChksumsMissingChksumMissingManifestMovedPackageUpdateMultiMovePackageUpdateOldMultiMovePackageUpdateOldPackageUpdatePackageUpdatesCheckPotentialGlobalUsePotentialLocalUseProjectMetadataCheckRedundantPackageUpdateRepoManifestHashCheckUnknownLicensesUnknownManifestUnnecessaryManifestUnusedEclassesUnusedEclassesCheckUnusedGlobalUseUnusedGlobalUseExpandUnusedLicensesUnusedLicensesCheckUnusedMirrorsUnusedMirrorsCheck
- pkgcheck.checks.reserved module
- pkgcheck.checks.ruby module
- pkgcheck.checks.rust module
- pkgcheck.checks.stablereq module
- pkgcheck.checks.unstable_only module
- pkgcheck.checks.visibility module
- pkgcheck.checks.whitespace module
Module contents¶
Core check classes.
- class pkgcheck.checks.AsyncCheck(*args, results_q)[source]¶
Bases:
CheckCheck that schedules tasks to be run asynchronously.
- runner_cls¶
alias of
AsyncCheckRunner
- scope = <PackageScope desc='version' @0x7f764341d220>¶
- class pkgcheck.checks.Check(options, **kwargs)[source]¶
Bases:
FeedBase template for a check.
- Variables:
scope – scope relative to the package repository the check runs under
source – source of feed items
known_results – result keywords the check can possibly yield
- known_results = frozenset({})¶
- priority¶
Priority that affects order in which checks are run.
- runner_cls¶
alias of
SyncCheckRunner
- scope = <PackageScope desc='version' @0x7f764341d220>¶
- property source¶
- class pkgcheck.checks.GentooRepoCheck(*args)[source]¶
Bases:
CheckCheck that is only run against the gentoo repo by default.
- scope = <PackageScope desc='version' @0x7f764341d220>¶
- class pkgcheck.checks.GitCommitsCheck(*args)[source]¶
Bases:
OptionalCheckCheck that is only run when explicitly enabled via the –commits git option.
- runner_cls¶
alias of
SequentialCheckRunner
- scope = <PackageScope desc='version' @0x7f764341d220>¶
- class pkgcheck.checks.MirrorsCheck(*args, use_addon)[source]¶
Bases:
CheckCheck that requires determining mirrors used by a given package.
- required_addons = (<class 'pkgcheck.addons.UseAddon'>,)¶
- scope = <PackageScope desc='version' @0x7f764341d220>¶
- class pkgcheck.checks.NetworkCheck(*args, net_addon, **kwargs)[source]¶
Bases:
AsyncCheck,OptionalCheckCheck that is only run when network support is enabled.
- required_addons = (<class 'pkgcheck.addons.NetAddon'>,)¶
- scope = <PackageScope desc='version' @0x7f764341d220>¶
- class pkgcheck.checks.OptionalCheck(options, **kwargs)[source]¶
Bases:
CheckCheck that is only run when explicitly enabled.
- scope = <PackageScope desc='version' @0x7f764341d220>¶
- class pkgcheck.checks.OverlayRepoCheck(*args)[source]¶
Bases:
CheckCheck that is only run against overlay repos.
- scope = <PackageScope desc='version' @0x7f764341d220>¶
- class pkgcheck.checks.RepoCheck(options, **kwargs)[source]¶
Bases:
CheckCheck that requires running at a repo level.
- runner_cls¶
alias of
RepoCheckRunner
- scope = <PackageScope desc='version' @0x7f764341d220>¶
- exception pkgcheck.checks.SkipCheck(check, msg)[source]¶
Bases:
PkgcheckUserExceptionCheck failed to initialize due to missing dependencies or other situation.
Checks not explicitly selected will be skipped if they raise this during initialization.