check_syntax

Syntax checks

These checks verify syntax (schema), in particular for the extra section that is otherwise free-form.

Classes

extra_identifiers_missing_colon(_linter)

Each item in the extra/identifiers section must be of form type:value

extra_identifiers_not_list(_linter)

The extra/identifiers section must be a list

extra_identifiers_not_string(_linter)

Each item in the extra/identifiers section must be a string

extra_skip_lints_not_list(_linter)

The extra/skip-lints section must contain a list

Documentation

class bioconda_utils.lint.check_syntax.extra_identifiers_missing_colon(_linter)[source]

Bases: bioconda_utils.lint.LintCheck

Each item in the extra/identifiers section must be of form type:value

Example:

extra:
   identifiers:
      - doi:123
check_recipe(recipe)[source]

Execute check on recipe

Override this method in subclasses, using self.message() to issue LintMessage as failures are encountered.

Parameters

recipe – The recipe under test.

class bioconda_utils.lint.check_syntax.extra_identifiers_not_list(_linter)[source]

Bases: bioconda_utils.lint.LintCheck

The extra/identifiers section must be a list

Example:

extra:
   identifiers:
      - doi:123
check_recipe(recipe)[source]

Execute check on recipe

Override this method in subclasses, using self.message() to issue LintMessage as failures are encountered.

Parameters

recipe – The recipe under test.

class bioconda_utils.lint.check_syntax.extra_identifiers_not_string(_linter)[source]

Bases: bioconda_utils.lint.LintCheck

Each item in the extra/identifiers section must be a string

Example:

extra:
   identifiers:
      - doi:123

Note that there is no space around the colon

check_recipe(recipe)[source]

Execute check on recipe

Override this method in subclasses, using self.message() to issue LintMessage as failures are encountered.

Parameters

recipe – The recipe under test.

class bioconda_utils.lint.check_syntax.extra_skip_lints_not_list(_linter)[source]

Bases: bioconda_utils.lint.LintCheck

The extra/skip-lints section must contain a list

Example:

extra:
   skip-lints:
      - should_use_compilers
check_recipe(recipe)[source]

Execute check on recipe

Override this method in subclasses, using self.message() to issue LintMessage as failures are encountered.

Parameters

recipe – The recipe under test.