pkgcheck.checks.header module

Various file-based header checks.

class pkgcheck.checks.header.EbuildHeaderCheck(*args)

Bases: _HeaderCheck

Scan ebuild for incorrect copyright/license headers.

known_results = frozenset({<class 'pkgcheck.checks.header.EbuildInvalidCopyright'>, <class 'pkgcheck.checks.header.EbuildInvalidLicenseHeader'>, <class 'pkgcheck.checks.header.EbuildNonGentooAuthorsCopyright'>, <class 'pkgcheck.checks.header.EbuildOldGentooCopyright'>})

scope = <PackageScope desc='version' @0x7fc9bedc9290>

class pkgcheck.checks.header.EbuildInvalidCopyright(line, **kwargs)

Bases: InvalidCopyright, VersionResult

File with invalid copyright.

The file does not start with a valid copyright line. Each ebuild or eclass file must start with a copyright line of the form:

# Copyright YEARS MAIN-CONTRIBUTOR [OTHER-CONTRIBUTOR]... [and others]

Files in the Gentoo repository must use:

# Copyright YEARS Gentoo Authors

name = 'InvalidCopyright'

class pkgcheck.checks.header.EbuildInvalidLicenseHeader(line, **kwargs)

Bases: InvalidLicenseHeader, VersionResult

File with invalid license header.

The file does not have with a valid license header.

Ebuilds and eclasses in the Gentoo repository must use:

# Distributed under the terms of the GNU General Public License v2

name = 'InvalidLicenseHeader'

class pkgcheck.checks.header.EbuildNonGentooAuthorsCopyright(line, **kwargs)

Bases: NonGentooAuthorsCopyright, VersionResult

File with copyright stating owner other than “Gentoo Authors”.

The file specifies explicit copyright owner, while the Gentoo repository policy specifies that all ebuilds and eclasses must use “Gentoo Authors”. If the owner is not listed in metadata/AUTHORS, addition can be requested via bugs.gentoo.org.

name = 'NonGentooAuthorsCopyright'

class pkgcheck.checks.header.EbuildOldGentooCopyright(line, **kwargs)

Bases: OldGentooCopyright, VersionResult

File with old Gentoo Foundation copyright.

The file still assigns copyright to the Gentoo Foundation even though it has been committed after the new copyright policy was approved (2018-10-21).

Ebuilds and eclasses in Gentoo repository must use ‘Gentoo Authors’ instead. Files in other repositories may specify an explicit copyright holder instead.

name = 'OldGentooCopyright'

class pkgcheck.checks.header.EclassHeaderCheck(*args)

Bases: _HeaderCheck

Scan eclasses for incorrect copyright/license headers.

known_results = frozenset({<class 'pkgcheck.checks.header.EclassInvalidCopyright'>, <class 'pkgcheck.checks.header.EclassInvalidLicenseHeader'>, <class 'pkgcheck.checks.header.EclassNonGentooAuthorsCopyright'>, <class 'pkgcheck.checks.header.EclassOldGentooCopyright'>})

scope = <LocationScope desc='eclass' @0x7fc9bedc9610>

class pkgcheck.checks.header.EclassInvalidCopyright(line, **kwargs)

Bases: InvalidCopyright, EclassResult

File with invalid copyright.

The file does not start with a valid copyright line. Each ebuild or eclass file must start with a copyright line of the form:

# Copyright YEARS MAIN-CONTRIBUTOR [OTHER-CONTRIBUTOR]... [and others]

Files in the Gentoo repository must use:

# Copyright YEARS Gentoo Authors

property desc

Result description.

name = 'InvalidCopyright'

class pkgcheck.checks.header.EclassInvalidLicenseHeader(line, **kwargs)

Bases: InvalidLicenseHeader, EclassResult

File with invalid license header.

The file does not have with a valid license header.

Ebuilds and eclasses in the Gentoo repository must use:

# Distributed under the terms of the GNU General Public License v2

property desc

Result description.

name = 'InvalidLicenseHeader'

class pkgcheck.checks.header.EclassNonGentooAuthorsCopyright(line, **kwargs)

Bases: NonGentooAuthorsCopyright, EclassResult

File with copyright stating owner other than “Gentoo Authors”.

The file specifies explicit copyright owner, while the Gentoo repository policy specifies that all ebuilds and eclasses must use “Gentoo Authors”. If the owner is not listed in metadata/AUTHORS, addition can be requested via bugs.gentoo.org.

property desc

Result description.

name = 'NonGentooAuthorsCopyright'

class pkgcheck.checks.header.EclassOldGentooCopyright(line, **kwargs)

Bases: OldGentooCopyright, EclassResult

File with old Gentoo Foundation copyright.

The file still assigns copyright to the Gentoo Foundation even though it has been committed after the new copyright policy was approved (2018-10-21).

Ebuilds and eclasses in Gentoo repository must use ‘Gentoo Authors’ instead. Files in other repositories may specify an explicit copyright holder instead.

property desc

Result description.

name = 'OldGentooCopyright'

class pkgcheck.checks.header.InvalidCopyright(line, **kwargs)

Bases: _FileHeaderResult, AliasResult, Error

File with invalid copyright.

The file does not start with a valid copyright line. Each ebuild or eclass file must start with a copyright line of the form:

# Copyright YEARS MAIN-CONTRIBUTOR [OTHER-CONTRIBUTOR]... [and others]

Files in the Gentoo repository must use:

# Copyright YEARS Gentoo Authors

property desc

Result description.

name = 'InvalidCopyright'

class pkgcheck.checks.header.InvalidLicenseHeader(line, **kwargs)

Bases: _FileHeaderResult, AliasResult, Error

File with invalid license header.

The file does not have with a valid license header.

Ebuilds and eclasses in the Gentoo repository must use:

# Distributed under the terms of the GNU General Public License v2

property desc

Result description.

name = 'InvalidLicenseHeader'

class pkgcheck.checks.header.NonGentooAuthorsCopyright(line, **kwargs)

Bases: _FileHeaderResult, AliasResult, Error

File with copyright stating owner other than “Gentoo Authors”.

The file specifies explicit copyright owner, while the Gentoo repository policy specifies that all ebuilds and eclasses must use “Gentoo Authors”. If the owner is not listed in metadata/AUTHORS, addition can be requested via bugs.gentoo.org.

property desc

Result description.

name = 'NonGentooAuthorsCopyright'

class pkgcheck.checks.header.OldGentooCopyright(line, **kwargs)

Bases: _FileHeaderResult, AliasResult, Warning

File with old Gentoo Foundation copyright.

The file still assigns copyright to the Gentoo Foundation even though it has been committed after the new copyright policy was approved (2018-10-21).

Ebuilds and eclasses in Gentoo repository must use ‘Gentoo Authors’ instead. Files in other repositories may specify an explicit copyright holder instead.

property desc

Result description.

name = 'OldGentooCopyright'