Source code for bioconda_utils.lint.check_policy

"""Policy compliance

This checks that recipes are in accordance with policy (as far as it
can be mechanically checked).

"""

import glob
import os

from . import LintCheck, ERROR, WARNING, INFO
from bioconda_utils import utils

[docs]class uses_vcs_url(LintCheck): """The recipe downloads source from a VCS Please build from source archives and don't use the ``git_url``, ``svn_url`` or ``hg_url`` feature of conda. """
[docs] def check_source(self, source, section): for vcs in ('git', 'svn', 'hg'): if f"{vcs}_url" in source: self.message(section=f"{section}/{vcs}_url")
[docs]class folder_and_package_name_must_match(LintCheck): """The recipe folder and package name do not match. For clarity, the name of the folder the ``meta.yaml`` resides, in and the name of the toplevel package should match. """
[docs] def check_recipe(self, recipe): recipe_base_folder, _, _ = recipe.reldir.partition('/') if recipe.name != recipe_base_folder: self.message(section='package/name')
[docs]class gpl_requires_license_distributed(LintCheck): """The recipe packages GPL software but is missing copy of license. The GPL requires that a copy of the license accompany all distributions of the software. Please add:: about: license_file: name_of_license_file If the upstream tar ball does not include a copy, please ask the authors of the software to add it to their distribution archive. """ severity = WARNING requires = ["missing_license"]
[docs] def check_recipe(self, recipe): if 'gpl' in recipe.get('about/license').lower(): if not recipe.get('about/license_file', ''): self.message('about/license')
[docs]class should_not_use_fn(LintCheck): """The recipe uses source/fn There is no need to specify the filename as the URL should give a name and it will in most cases be unpacked automatically. """
[docs] def check_source(self, source, section): if 'fn' in source: self.message(section=section+'/fn')
[docs]class has_windows_bat_file(LintCheck): """The recipe directory contains a ``bat`` file. Bioconda does not currently build packages for Windows (and has at this time no plans to change this), so these files cannot be tested. Please remove any ``*.bat`` files generated by ``conda skeleton`` from the recipe directory. """
[docs] def check_recipe(self, recipe): for fname in glob.glob(os.path.join(recipe.dir, '*.bat')): self.message(fname=fname)
[docs]class long_summary(LintCheck): """The summary line is rather long Consider using the description field for longer text:: about: summary: Fancy Read Simulator (makes drinks) description: | XYZ is a very fancy read simulator that will not just make coffee while you are waiting but prepare all kinds of exquisite caffeeinated beverages from freshly roasted, single source beans ground to match ambient humidity. This will fit better into the templates listing and describing recipes, which assume the summary to be a title and the description to be one or more paragraphs. """ severity = WARNING max_length = 120
[docs] def check_recipe(self, recipe): if len(recipe.get('about/summary', '')) > self.max_length: self.message('about/summary')
[docs]class cran_packages_to_conda_forge(LintCheck): """CRAN packages not depending on Bioconda should go to Conda-Forge This recipe builds a CRAN package and does not depend on packages from Bioconda. It should therefore be moved to Conda-Forge. """
[docs] def check_deps(self, deps): # must have R in run a run dep if 'R' in deps and any('run' in dep for dep in deps['R']): # and all deps satisfied in conda-forge if all(utils.RepoData().get_package_data(name=dep, channels='conda-forge') for dep in deps): self.message()