pkgcheck.checks package¶
Submodules¶
- pkgcheck.checks.acct module
- pkgcheck.checks.cleanup module
- pkgcheck.checks.codingstyle module- AbsoluteSymlink
- AbsoluteSymlinkCheck
- BadCommandsCheck
- BannedEapiCommand
- BannedPhaseCall
- BetterCompressionCheck
- BetterCompressionUri
- DeclarationShadowedCheck
- DeprecatedEapiCommand
- DeprecatedInsinto
- DoCompressedFilesCheck
- DoublePrefixInPath
- DuplicateFunctionDefinition
- EbuildUnquotedVariable
- EbuildUnquotedVariablesCheck
- EbuildVariableScope
- EclassUnquotedVariable
- EclassUnquotedVariablesCheck
- EendMissingArg
- EendMissingArgCheck
- EmptyGlobalAssignment
- ExcessiveLineLength
- GlobCheck
- GlobDistdir
- HomepageInSrcUri
- IndirectInherits
- InheritsCheck
- InsintoCheck
- InstallCompressedInfo
- InstallCompressedManpage
- InternalEclassUsage
- InvalidSandboxCall
- LineLengthCheck
- MetadataVarCheck
- MissingInherits
- MissingSlash
- MultipleKeywordsLines
- NonConsistentTarUsage
- NonPosixCheck
- NonPosixHeadTailUsage
- ObsoleteUri
- ObsoleteUriCheck
- PathVariablesCheck
- ReadonlyVariable
- ReadonlyVariableCheck
- RedundantDodir
- RedundantDodirCheck
- ReferenceInMetadataVar
- SandboxCallCheck
- SelfAssignment
- StaticSrcUri
- UnnecessarySlashStrip
- UnquotedVariable
- UnusedInherits
- VariableOrderCheck
- VariableOrderWrong
- VariableScope
- VariableScopeCheck
- VariableShadowed
- verify_vars()
 
- pkgcheck.checks.dropped_keywords module
- pkgcheck.checks.eclass module- DeprecatedEclass
- DeprecatedEclassFunction
- DeprecatedEclassVariable
- DuplicateEclassInherit
- EclassBashSyntaxError
- EclassCheck
- EclassDocError
- EclassDocMissingFunc
- EclassDocMissingVar
- EclassExportFuncsBeforeInherit
- EclassManualDepsCheck
- EclassParseCheck
- EclassUsageCheck- EclassUsageCheck.check_deprecated_functions()
- EclassUsageCheck.check_deprecated_variables()
- EclassUsageCheck.check_pre_inherits()
- EclassUsageCheck.check_provided_eclasses()
- EclassUsageCheck.check_user_variables()
- EclassUsageCheck.feed()
- EclassUsageCheck.known_results
- EclassUsageCheck.required_addons
- EclassUsageCheck.scope
 
- EclassUserVariableUsage
- EclassVariableScope
- GoMissingDeps
- MisplacedEclassVar
- ProvidedEclassInherit
- RubyMissingDeps
- RustMissingDeps
- TmpfilesMissingDeps
 
- pkgcheck.checks.git module- BadCommitSummary
- DirectNoMaintainer
- DirectStableKeywords
- DroppedStableKeywords
- DroppedUnstableKeywords
- EAPIChangeWithoutRevbump
- EbuildIncorrectCopyright
- EclassIncorrectCopyright
- GitCommitMessageCheck
- GitCommitsRepoSource
- GitCommitsSource
- GitEclassCommitsCheck
- GitPkgCommitsCheck- GitPkgCommitsCheck.added_repo
- GitPkgCommitsCheck.addition_checks()
- GitPkgCommitsCheck.allowed_direct_stable
- GitPkgCommitsCheck.cleanup()
- GitPkgCommitsCheck.env_array_elem_regex
- GitPkgCommitsCheck.feed()
- GitPkgCommitsCheck.known_results
- GitPkgCommitsCheck.modified_checks()
- GitPkgCommitsCheck.modified_repo
- GitPkgCommitsCheck.python_compat_declare_regex
- GitPkgCommitsCheck.python_pep517_regex
- GitPkgCommitsCheck.removal_checks()
- GitPkgCommitsCheck.removal_repo
- GitPkgCommitsCheck.rename_checks()
- GitPkgCommitsCheck.required_addons
- GitPkgCommitsCheck.scope
- GitPkgCommitsCheck.src_uri_changes()
 
- IncorrectCopyright
- InvalidCommitMessage
- InvalidCommitTag
- MissingMove
- MissingSignOff
- MissingSlotmove
- NewerEAPIAvailable
- OldPythonCompat
- PythonPEP517WithoutRevbump
- RdependChange
- SrcUriChecksumChange
- SuspiciousSrcUriChange
- verify_tags()
 
- pkgcheck.checks.glsa module
- pkgcheck.checks.header module- EbuildHeaderCheck
- EbuildInvalidCopyright
- EbuildInvalidLicenseHeader
- EbuildNonGentooAuthorsCopyright
- EbuildOldGentooCopyright
- EclassHeaderCheck
- EclassInvalidCopyright
- EclassInvalidLicenseHeader
- EclassNonGentooAuthorsCopyright
- EclassOldGentooCopyright
- InvalidCopyright
- InvalidLicenseHeader
- NonGentooAuthorsCopyright
- OldGentooCopyright
 
- pkgcheck.checks.imlate module
- pkgcheck.checks.metadata module- BadDefaultUseFlags
- BadDependency
- BadDescription
- BadFilename
- BadHomepage
- BadKeywords
- BadProtocol
- BannedEapi
- DependencyCheck
- DeprecatedDep
- DeprecatedEapi
- DeprecatedLicense
- DescriptionCheck
- DuplicateKeywords
- EapiCheck
- HomepageCheck
- InvalidBdepend
- InvalidDepend
- InvalidEapi
- InvalidIdepend
- InvalidLicense
- InvalidPdepend
- InvalidProperties
- InvalidRdepend
- InvalidRequiredUse
- InvalidRestrict
- InvalidSlot
- InvalidSrcUri
- InvalidUseFlags
- IuseCheck
- KeywordsCheck
- LicenseCheck
- LocalUseCheck
- MatchingGlobalUse
- MisplacedWeakBlocker
- MissingLicense
- MissingLicenseRestricts
- MissingLocalUseDesc
- MissingPackageRevision
- MissingSlotDep
- MissingSlotDepCheck
- MissingTestRestrict
- MissingUnpackerDep
- MissingUnpackerDepCheck
- MissingUri
- MissingUseDepDefault
- NonexistentBlocker
- OutdatedBlocker
- OutdatedBlockersCheck
- OverlappingKeywords
- ProbableGlobalUse
- ProbableUseExpand
- PropertiesCheck
- RedundantUriRename
- RequiredUseCheck
- RequiredUseDefaults
- RestrictCheck
- RestrictTestCheck
- SourcingCheck
- SourcingError
- SrcUriCheck
- SrcUriFilenameDotPrefix
- StableKeywordsOnTestingEapi
- StaleLiveCheck
- StaleLiveEAPI
- TarballAvailable
- UnderscoreInUseFlag
- UnknownKeywords
- UnknownLicense
- UnknownMirror
- UnknownProperties
- UnknownRestrict
- UnknownUseFlags
- UnnecessaryLicense
- UnsortedKeywords
- UnstableSrcUri
- UnsupportedEclassEapi
- UnusedLocalUse
- UseFlagWithoutDeps
- UseFlagsWithoutEffectsCheck
- VirtualKeywordsUpdate
- VirtualProvidersCheck
- VirtualWithBdepend
- VirtualWithDepend
- VirtualWithSingleProvider
 
- pkgcheck.checks.metadata_xml module- CatBadlyFormedXml
- CatInvalidXml
- CatMetadataXmlEmptyElement
- CatMetadataXmlIndentation
- CatMetadataXmlInvalidCatRef
- CatMetadataXmlInvalidPkgRef
- CatMissingMetadataXml
- CategoryMetadataXmlCheck- CategoryMetadataXmlCheck.catref_error
- CategoryMetadataXmlCheck.empty_element
- CategoryMetadataXmlCheck.indent_error
- CategoryMetadataXmlCheck.invalid_error
- CategoryMetadataXmlCheck.known_results
- CategoryMetadataXmlCheck.misformed_error
- CategoryMetadataXmlCheck.missing_error
- CategoryMetadataXmlCheck.pkgref_error
- CategoryMetadataXmlCheck.scope
 
- InvalidMetadataRestrict
- InvalidRemoteID
- MaintainerNeeded
- MaintainerWithoutProxy
- MissingRemoteId
- MissingRemoteIdCheck
- NonexistentProjectMaintainer
- PackageMetadataXmlCheck- PackageMetadataXmlCheck.catref_error
- PackageMetadataXmlCheck.empty_element
- PackageMetadataXmlCheck.indent_error
- PackageMetadataXmlCheck.invalid_error
- PackageMetadataXmlCheck.known_results
- PackageMetadataXmlCheck.misformed_error
- PackageMetadataXmlCheck.missing_error
- PackageMetadataXmlCheck.pkgref_error
- PackageMetadataXmlCheck.remote_id_validators
- PackageMetadataXmlCheck.scope
 
- PkgBadlyFormedXml
- PkgInvalidXml
- PkgMetadataXmlEmptyElement
- PkgMetadataXmlIndentation
- PkgMetadataXmlInvalidCatRef
- PkgMetadataXmlInvalidPkgRef
- PkgMissingMetadataXml
- ProxyWithoutProxied
- RedundantLongDescription
- WrongMaintainerType
 
- pkgcheck.checks.network module
- pkgcheck.checks.overlays module
- pkgcheck.checks.perl module
- pkgcheck.checks.pkgdir module
- pkgcheck.checks.profiles module- ArchesOutOfSync
- ArchesWithoutProfiles
- BannedProfileEapi
- DeprecatedProfileEapi
- LaggingProfileEapi
- NonexistentCategories
- NonexistentProfilePath
- OutdatedProfilePackage
- ProfileError
- ProfileMissingImplicitExpandValues
- ProfileWarning
- ProfilesCheck
- RepoProfilesCheck
- SystemSetMissingKeywords
- UnknownCategoryDirs
- UnknownProfileArch
- UnknownProfilePackage
- UnknownProfilePackageKeywords
- UnknownProfilePackageUse
- UnknownProfileUse
- UnknownProfileUseExpand
- UnknownProfileUseExpandValue
- UnmatchedProfilePackageUnmask
- UnusedProfileDirs
- dir_parents()
- verify_files()
 
- pkgcheck.checks.python module- DistutilsNonPEP517Build
- EPyTestPluginsSuggestion
- MisplacedEPyTestVar
- MissingPythonEclass
- PythonAnyMismatchedDepHasVersionCheck
- PythonAnyMismatchedUseHasVersionCheck
- PythonCheck- PythonCheck.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_func
- PythonCheck.feed()
- PythonCheck.has_version_default
- PythonCheck.has_version_known_flags
- PythonCheck.known_results
- PythonCheck.report_mismatch_check_deps()
- PythonCheck.scan_tree_recursively()
- PythonCheck.scope
- PythonCheck.setuptools_scm
 
- PythonCompatCheck
- PythonCompatUpdate
- PythonEclassError
- PythonFetchableCheck- PythonFetchableCheck.check_gh_suffix()
- PythonFetchableCheck.check_pypi_mirror()
- PythonFetchableCheck.feed()
- PythonFetchableCheck.known_results
- PythonFetchableCheck.normalize_distribution_name()
- PythonFetchableCheck.required_addons
- PythonFetchableCheck.scope
- PythonFetchableCheck.simplify_pn_pv()
- PythonFetchableCheck.translate_version()
 
- PythonGHDistfileSuffix
- PythonHasVersionMissingPythonUseDep
- PythonHasVersionUsage
- PythonInlinePyPIURI
- PythonMismatchedPackageName
- PythonMissingDeps
- PythonMissingRequiredUse
- PythonMissingSCMDependency
- PythonPackageNameCheck
- PythonRuntimeDepInAnyR1
- RedundantPyTestDisablePluginAutoload
- ShadowedEPyTestTimeout
- get_python_eclass()
- is_python_interpreter()
 
- pkgcheck.checks.repo module
- pkgcheck.checks.repo_metadata module- BadPackageUpdate
- ConflictingChksums
- DeprecatedChksum
- DeprecatedManifestHash
- DeprecatedRepoHash
- EmptyProject
- GlobalUseCheck
- InvalidManifest
- LicenseGroupsCheck
- ManifestCheck
- ManifestCollisionCheck
- MatchingChksums
- MissingChksum
- MissingManifest
- MovedPackageUpdate
- MultiMovePackageUpdate
- OldMultiMovePackageUpdate
- OldPackageUpdate
- PackageUpdatesCheck
- PotentialGlobalUse
- PotentialLocalUse
- ProjectMetadataCheck
- RedundantPackageUpdate
- RepoManifestHashCheck
- UnknownLicenses
- UnknownManifest
- UnnecessaryManifest
- UnusedEclasses
- UnusedEclassesCheck
- UnusedGlobalUse
- UnusedGlobalUseExpand
- UnusedLicenses
- UnusedLicensesCheck
- UnusedMirrors
- UnusedMirrorsCheck
 
- 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: - Check- Check that schedules tasks to be run asynchronously. - runner_cls¶
- alias of - AsyncCheckRunner
 - scope = <PackageScope desc='version' @0x7fb1134c5220>¶
 
- class pkgcheck.checks.Check(options, **kwargs)[source]¶
- Bases: - Feed- Base 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' @0x7fb1134c5220>¶
 - property source¶
 
- class pkgcheck.checks.GentooRepoCheck(*args)[source]¶
- Bases: - Check- Check that is only run against the gentoo repo by default. - scope = <PackageScope desc='version' @0x7fb1134c5220>¶
 
- class pkgcheck.checks.GitCommitsCheck(*args)[source]¶
- Bases: - OptionalCheck- Check that is only run when explicitly enabled via the –commits git option. - runner_cls¶
- alias of - SequentialCheckRunner
 - scope = <PackageScope desc='version' @0x7fb1134c5220>¶
 
- class pkgcheck.checks.MirrorsCheck(*args, use_addon)[source]¶
- Bases: - Check- Check that requires determining mirrors used by a given package. - required_addons = (<class 'pkgcheck.addons.UseAddon'>,)¶
 - scope = <PackageScope desc='version' @0x7fb1134c5220>¶
 
- class pkgcheck.checks.NetworkCheck(*args, net_addon, **kwargs)[source]¶
- Bases: - AsyncCheck,- OptionalCheck- Check that is only run when network support is enabled. - required_addons = (<class 'pkgcheck.addons.NetAddon'>,)¶
 - scope = <PackageScope desc='version' @0x7fb1134c5220>¶
 
- class pkgcheck.checks.OptionalCheck(options, **kwargs)[source]¶
- Bases: - Check- Check that is only run when explicitly enabled. - scope = <PackageScope desc='version' @0x7fb1134c5220>¶
 
- class pkgcheck.checks.OverlayRepoCheck(*args)[source]¶
- Bases: - Check- Check that is only run against overlay repos. - scope = <PackageScope desc='version' @0x7fb1134c5220>¶
 
- class pkgcheck.checks.RepoCheck(options, **kwargs)[source]¶
- Bases: - Check- Check that requires running at a repo level. - runner_cls¶
- alias of - RepoCheckRunner
 - scope = <PackageScope desc='version' @0x7fb1134c5220>¶
 
- exception pkgcheck.checks.SkipCheck(check, msg)[source]¶
- Bases: - PkgcheckUserException- Check failed to initialize due to missing dependencies or other situation. - Checks not explicitly selected will be skipped if they raise this during initialization.