Bear.get_metadata() - Code Metrics - Inspection of "show_bears and filter_by_language in coala-json" - coala-analyzer/coala - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#2337)

unknown

created 2016-07-09 18:14 UTC

Bear.get_metadata() A

↳ Parent: Bear

Complexity

Conditions

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
dl	0
loc	10
rs	9.4285
c	0
b	0
f	0

import traceback
from functools import partial
from os import makedirs
from os.path import join, abspath, exists
from shutil import copyfileobj
from urllib.request import urlopen

from appdirs import user_data_dir

from pyprint.Printer import Printer

from coala_decorators.decorators import (
    enforce_signature, classproperty, get_public_members)
from coalib.bears.requirements.PackageRequirement import PackageRequirement

from coalib.bears.requirements.PipRequirement import PipRequirement

from coalib.output.printers.LogPrinter import LogPrinter
from coalib.results.Result import Result
from coalib.settings.FunctionMetadata import FunctionMetadata
from coalib.settings.Section import Section
from coalib.settings.ConfigurationGathering import get_config_directory


class Bear(Printer, LogPrinter):
    """
    A bear contains the actual subroutine that is responsible for checking
    source code for certain specifications. However it can actually do
    whatever it wants with the files it gets. If you are missing some Result
    type, feel free to contact us and/or help us extending the coalib.

    This is the base class for every bear. If you want to write an bear, you
    will probably want to look at the GlobalBear and LocalBear classes that
    inherit from this class. In any case you'll want to overwrite at least the
    run method. You can send debug/warning/error messages through the
    debug(), warn(), err() functions. These will send the
    appropriate messages so that they are outputted. Be aware that if you use
    err(), you are expected to also terminate the bear run-through
    immediately.

    If you need some setup or teardown for your bear, feel free to overwrite
    the set_up() and tear_down() functions. They will be invoked
    before/after every run invocation.

    Settings are available at all times through self.section.

    To indicate which languages your bear supports, just give it the
    ``LANGUAGES`` value which should be a set of string(s):

    >>> class SomeBear(Bear):
    ...     LANGUAGES = {'C', 'CPP','C#', 'D'}

    To indicate the requirements of the bear, assign ``REQUIREMENTS`` a set
    with instances of ``PackageRequirements``.

    >>> class SomeBear(Bear):
    ...     REQUIREMENTS = {
    ...         PackageRequirement('pip', 'coala_decorators', '0.2.1')}

    If your bear uses requirements from a manager we have a subclass from,
    you can use the subclass, such as ``PipRequirement``, without specifying
    manager:

    >>> class SomeBear(Bear):
    ...     REQUIREMENTS = {PipRequirement('coala_decorators', '0.2.1')}

    To specify multiple requirements using ``pip``, you can use the multiple
    method. This can receive both tuples of strings, in case you want a specific
    version, or a simple string, in case you want the latest version to be
    specified.

    >>> class SomeBear(Bear):
    ...     REQUIREMENTS = PipRequirement.multiple(
    ...         ('colorama', '0.1'), 'coala_decorators')

    To specify additional attributes to your bear, use the following:

    >>> class SomeBear(Bear):
    ...     AUTHORS = {'Jon Snow'}
    ...     AUTHORS_EMAILS = {'[email protected]'}
    ...     MAINTAINERS = {'Catelyn Stark'}
    ...     MAINTAINERS_EMAILS = {'[email protected]'}
    ...     LICENSE = 'AGPL-3.0'

    If the maintainers are the same as the authors, they can be omitted:

    >>> class SomeBear(Bear):
    ...     AUTHORS = {'Jon Snow'}
    ...     AUTHORS_EMAILS = {'[email protected]'}
    >>> SomeBear.maintainers
    {'Jon Snow'}
    >>> SomeBear.maintainers_emails
    {'[email protected]'}

    If your bear needs to include local files, then specify it giving strings
    containing relative file paths to the INCLUDE_LOCAL_FILES set:

    >>> class SomeBear(Bear):
    ...     INCLUDE_LOCAL_FILES = {'checkstyle.jar', 'google_checks.xml'}

    To keep track easier of what a bear can do, simply tell it to the CAN_FIX
    and the CAN_DETECT sets. Possible values:

    >>> CAN_DETECT = {'Syntax', 'Formatting', 'Security', 'Complexity', 'Smell',
    ... 'Unused Code', 'Redundancy', 'Variable Misuse', 'Spelling',
    ... 'Memory Leak', 'Documentation', 'Duplication', 'Commented Code',
    ... 'Grammar', 'Missing Import', 'Unreachable Code', 'Undefined Element',
    ... 'Code Simplification'}
    >>> CAN_FIX = {'Syntax', ...}

    Specifying something to CAN_FIX makes it obvious that it can be detected
    too, so it may be omitted:

    >>> class SomeBear(Bear):
    ...     CAN_DETECT = {'Syntax', 'Security'}
    ...     CAN_FIX = {'Redundancy'}
    >>> list(sorted(SomeBear.can_detect))
    ['Redundancy', 'Security', 'Syntax']

    Every bear has a data directory which is unique to that particular bear:

    >>> class SomeBear(Bear): pass
    >>> class SomeOtherBear(Bear): pass
    >>> SomeBear.data_dir == SomeOtherBear.data_dir
    False
    """

    LANGUAGES = set()
    REQUIREMENTS = set()
    AUTHORS = set()
    AUTHORS_EMAILS = set()
    MAINTAINERS = set()
    MAINTAINERS_EMAILS = set()
    PLATFORMS = {'any'}
    LICENSE = ''
    INCLUDE_LOCAL_FILES = set()
    CAN_DETECT = set()
    CAN_FIX = set()

    @classproperty
    def name(cls):
        """
        :return: The name of the bear
        """
        return cls.__name__

    @classproperty
    def can_detect(cls):
        """
        :return: A set that contains everything a bear can detect, gathering
                 information from what it can fix too.
        """
        return cls.CAN_DETECT | cls.CAN_FIX

    @classproperty
    def maintainers(cls):
        """
        :return: A set containing ``MAINTAINERS`` if specified, else takes
                 ``AUTHORS`` by default.
        """
        return cls.AUTHORS if cls.MAINTAINERS == set() else cls.MAINTAINERS

    @classproperty
    def maintainers_emails(cls):
        """
        :return: A set containing ``MAINTAINERS_EMAILS`` if specified, else
                 takes ``AUTHORS_EMAILS`` by default.
        """
        return (cls.AUTHORS_EMAILS if cls.MAINTAINERS_EMAILS == set()
                else cls.MAINTAINERS)

    @enforce_signature
    def __init__(self,
                 section: Section,
                 message_queue,
                 timeout=0):
        """
        Constructs a new bear.

        :param section:       The section object where bear settings are
                              contained.
        :param message_queue: The queue object for messages. Can be ``None``.
        :param timeout:       The time the bear is allowed to run. To set no
                              time limit, use 0.
        :raises TypeError:    Raised when ``message_queue`` is no queue.
        :raises RuntimeError: Raised when bear requirements are not fulfilled.
        """
        Printer.__init__(self)
        LogPrinter.__init__(self, self)

        if message_queue is not None and not hasattr(message_queue, "put"):
            raise TypeError("message_queue has to be a Queue or None.")

        self.section = section
        self.message_queue = message_queue
        self.timeout = timeout

        self.setup_dependencies()
        cp = type(self).check_prerequisites()
        if cp is not True:
            error_string = ("The bear " + self.name +
                            " does not fulfill all requirements.")
            if cp is not False:
                error_string += " " + cp

            self.warn(error_string)
            raise RuntimeError(error_string)

    def _print(self, output, **kwargs):
        self.debug(output)

    def log_message(self, log_message, timestamp=None, **kwargs):
        if self.message_queue is not None:
            self.message_queue.put(log_message)

    def run(self, *args, dependency_results=None, **kwargs):
        raise NotImplementedError

    def run_bear_from_section(self, args, kwargs):
        try:
            kwargs.update(
                self.get_metadata().create_params_from_section(self.section))
        except ValueError as err:
            self.warn("The bear {} cannot be executed.".format(
                self.name), str(err))
            return

        return self.run(*args, **kwargs)

    def execute(self, *args, **kwargs):
        name = self.name
        try:
            self.debug("Running bear {}...".format(name))
            # If it's already a list it won't change it
            return list(self.run_bear_from_section(args, kwargs) or [])
        except:
            self.warn(
                "Bear {} failed to run. Take a look at debug messages (`-L "
                "DEBUG`) for further information.".format(name))
            self.debug(
                "The bear {bear} raised an exception. If you are the writer "
                "of this bear, please make sure to catch all exceptions. If "
                "not and this error annoys you, you might want to get in "
                "contact with the writer of this bear.\n\nTraceback "
                "information is provided below:\n\n{traceback}"
                "\n".format(bear=name, traceback=traceback.format_exc()))

    @staticmethod
    def kind():
        """
        :return: The kind of the bear
        """
        raise NotImplementedError

    @classmethod
    def get_metadata(cls):
        """
        :return: Metadata for the run function. However parameters like
                 ``self`` or parameters implicitly used by coala (e.g.
                 filename for local bears) are already removed.
        """
        return FunctionMetadata.from_function(
            cls.run,
            omit={"self", "dependency_results"})

    @classmethod
    def __json__(cls):
        """
        Override JSON export of ``Bear`` object.
        """
        _dict = get_public_members(cls)
        metadata = cls.get_metadata()
        non_optional_params = metadata.non_optional_params
        optional_params = metadata.optional_params
        _dict["metadata"] = {
            "desc": metadata.desc,
            "non_optional_params": [({param: non_optional_params[param][0]}
                                     for param in non_optional_params)],
            "optional_params": [({param: optional_params[param][0]}
                                 for param in optional_params)]}

        # Delete attributes that cannot be serialized
        unserializable_attributes = ["new_result", "printer"]
        for attribute in unserializable_attributes:
            _dict.pop(attribute, None)
        return _dict

    @classmethod
    def missing_dependencies(cls, lst):
        """
        Checks if the given list contains all dependencies.

        :param lst: A list of all already resolved bear classes (not
                    instances).
        :return:    A list of missing dependencies.
        """
        dep_classes = cls.get_dependencies()

        for item in lst:
            if item in dep_classes:
                dep_classes.remove(item)

        return dep_classes

    @staticmethod
    def get_dependencies():
        """
        Retrieves bear classes that are to be executed before this bear gets
        executed. The results of these bears will then be passed to the
        run method as a dict via the dependency_results argument. The dict
        will have the name of the Bear as key and the list of its results as
        results.

        :return: A list of bear classes.
        """
        return []

    @classmethod
    def get_non_optional_settings(cls):
        """
        This method has to determine which settings are needed by this bear.
        The user will be prompted for needed settings that are not available
        in the settings file so don't include settings where a default value
        would do.

        :return: A dictionary of needed settings as keys and a tuple of help
                 text and annotation as values
        """
        return cls.get_metadata().non_optional_params

    @staticmethod
    def setup_dependencies():
        """
        This is a user defined function that can download and set up
        dependencies (via download_cached_file or arbitary other means) in an OS
        independent way.
        """

    @classmethod
    def check_prerequisites(cls):
        """
        Checks whether needed runtime prerequisites of the bear are satisfied.

        This function gets executed at construction and returns True by
        default.

        Section value requirements shall be checked inside the ``run`` method.

        :return: True if prerequisites are satisfied, else False or a string
                 that serves a more detailed description of what's missing.
        """
        return True

    def get_config_dir(self):
        """
        Gives the directory where the configuration file is

        :return: Directory of the config file
        """
        return get_config_directory(self.section)

    def download_cached_file(self, url, filename):
        """
        Downloads the file if needed and caches it for the next time. If a
        download happens, the user will be informed.

        Take a sane simple bear:

        >>> from queue import Queue
        >>> bear = Bear(Section("a section"), Queue())

        We can now carelessly query for a neat file that doesn't exist yet:

        >>> from os import remove
        >>> if exists(join(bear.data_dir, "a_file")):
        ...     remove(join(bear.data_dir, "a_file"))
        >>> file = bear.download_cached_file("http://gitmate.com/", "a_file")

        If we download it again, it'll be much faster as no download occurs:

        >>> newfile = bear.download_cached_file("http://gitmate.com/", "a_file")
        >>> newfile == file
        True

        :param url:      The URL to download the file from.
        :param filename: The filename it should get, e.g. "test.txt".
        :return:         A full path to the file ready for you to use!
        """
        filename = join(self.data_dir, filename)
        if exists(filename):
            return filename

        self.info("Downloading {filename!r} for bear {bearname} from {url}."
                  .format(filename=filename, bearname=self.name, url=url))

        with urlopen(url) as response, open(filename, 'wb') as out_file:
            copyfileobj(response, out_file)
        return filename

    @classproperty
    def data_dir(cls):
        """
        Returns a directory that may be used by the bear to store stuff. Every
        bear has an own directory dependent on his name.
        """
        data_dir = abspath(join(user_data_dir('coala-bears'), cls.name))

        makedirs(data_dir, exist_ok=True)
        return data_dir

    @property
    def new_result(self):
        """
        Returns a partial for creating a result with this bear already bound.
        """
        return partial(Result.from_values, self)


1			import traceback
2			from functools import partial
3			from os import makedirs
4			from os.path import join, abspath, exists
5			from shutil import copyfileobj
6			from urllib.request import urlopen
7
8			from appdirs import user_data_dir
9
10			from pyprint.Printer import Printer
11
12			from coala_decorators.decorators import (
13			enforce_signature, classproperty, get_public_members)
14			from coalib.bears.requirements.PackageRequirement import PackageRequirement
			0 ignored issues – show Unused Code introduced 2016-05-23 19:58 UTC by Report Bug Copy Issue Report Unused PackageRequirement imported from coalib.bears.requirements.PackageRequirement Loading history...
15			from coalib.bears.requirements.PipRequirement import PipRequirement
			0 ignored issues – show Unused Code introduced 2016-06-19 17:12 UTC by Report Bug Copy Issue Report Unused PipRequirement imported from coalib.bears.requirements.PipRequirement Loading history...
16			from coalib.output.printers.LogPrinter import LogPrinter
17			from coalib.results.Result import Result
18			from coalib.settings.FunctionMetadata import FunctionMetadata
19			from coalib.settings.Section import Section
20			from coalib.settings.ConfigurationGathering import get_config_directory
21
22
23			class Bear(Printer, LogPrinter):
24			"""
25			A bear contains the actual subroutine that is responsible for checking
26			source code for certain specifications. However it can actually do
27			whatever it wants with the files it gets. If you are missing some Result
28			type, feel free to contact us and/or help us extending the coalib.
29
30			This is the base class for every bear. If you want to write an bear, you
31			will probably want to look at the GlobalBear and LocalBear classes that
32			inherit from this class. In any case you'll want to overwrite at least the
33			run method. You can send debug/warning/error messages through the
34			debug(), warn(), err() functions. These will send the
35			appropriate messages so that they are outputted. Be aware that if you use
36			err(), you are expected to also terminate the bear run-through
37			immediately.
38
39			If you need some setup or teardown for your bear, feel free to overwrite
40			the set_up() and tear_down() functions. They will be invoked
41			before/after every run invocation.
42
43			Settings are available at all times through self.section.
44
45			To indicate which languages your bear supports, just give it the
46			``LANGUAGES`` value which should be a set of string(s):
47
48			>>> class SomeBear(Bear):
49			... LANGUAGES = {'C', 'CPP','C#', 'D'}
50
51			To indicate the requirements of the bear, assign ``REQUIREMENTS`` a set
52			with instances of ``PackageRequirements``.
53
54			>>> class SomeBear(Bear):
55			... REQUIREMENTS = {
56			... PackageRequirement('pip', 'coala_decorators', '0.2.1')}
57
58			If your bear uses requirements from a manager we have a subclass from,
59			you can use the subclass, such as ``PipRequirement``, without specifying
60			manager:
61
62			>>> class SomeBear(Bear):
63			... REQUIREMENTS = {PipRequirement('coala_decorators', '0.2.1')}
64
65			To specify multiple requirements using ``pip``, you can use the multiple
66			method. This can receive both tuples of strings, in case you want a specific
67			version, or a simple string, in case you want the latest version to be
68			specified.
69
70			>>> class SomeBear(Bear):
71			... REQUIREMENTS = PipRequirement.multiple(
72			... ('colorama', '0.1'), 'coala_decorators')
73
74			To specify additional attributes to your bear, use the following:
75
76			>>> class SomeBear(Bear):
77			... AUTHORS = {'Jon Snow'}
78			... AUTHORS_EMAILS = {'[email protected]'}
79			... MAINTAINERS = {'Catelyn Stark'}
80			... MAINTAINERS_EMAILS = {'[email protected]'}
81			... LICENSE = 'AGPL-3.0'
82
83			If the maintainers are the same as the authors, they can be omitted:
84
85			>>> class SomeBear(Bear):
86			... AUTHORS = {'Jon Snow'}
87			... AUTHORS_EMAILS = {'[email protected]'}
88			>>> SomeBear.maintainers
89			{'Jon Snow'}
90			>>> SomeBear.maintainers_emails
91			{'[email protected]'}
92
93			If your bear needs to include local files, then specify it giving strings
94			containing relative file paths to the INCLUDE_LOCAL_FILES set:
95
96			>>> class SomeBear(Bear):
97			... INCLUDE_LOCAL_FILES = {'checkstyle.jar', 'google_checks.xml'}
98
99			To keep track easier of what a bear can do, simply tell it to the CAN_FIX
100			and the CAN_DETECT sets. Possible values:
101
102			>>> CAN_DETECT = {'Syntax', 'Formatting', 'Security', 'Complexity', 'Smell',
103			... 'Unused Code', 'Redundancy', 'Variable Misuse', 'Spelling',
104			... 'Memory Leak', 'Documentation', 'Duplication', 'Commented Code',
105			... 'Grammar', 'Missing Import', 'Unreachable Code', 'Undefined Element',
106			... 'Code Simplification'}
107			>>> CAN_FIX = {'Syntax', ...}
108
109			Specifying something to CAN_FIX makes it obvious that it can be detected
110			too, so it may be omitted:
111
112			>>> class SomeBear(Bear):
113			... CAN_DETECT = {'Syntax', 'Security'}
114			... CAN_FIX = {'Redundancy'}
115			>>> list(sorted(SomeBear.can_detect))
116			['Redundancy', 'Security', 'Syntax']
117
118			Every bear has a data directory which is unique to that particular bear:
119
120			>>> class SomeBear(Bear): pass
121			>>> class SomeOtherBear(Bear): pass
122			>>> SomeBear.data_dir == SomeOtherBear.data_dir
123			False
124			"""
125
126			LANGUAGES = set()
127			REQUIREMENTS = set()
128			AUTHORS = set()
129			AUTHORS_EMAILS = set()
130			MAINTAINERS = set()
131			MAINTAINERS_EMAILS = set()
132			PLATFORMS = {'any'}
133			LICENSE = ''
134			INCLUDE_LOCAL_FILES = set()
135			CAN_DETECT = set()
136			CAN_FIX = set()
137
138			@classproperty
139			def name(cls):
140			"""
141			:return: The name of the bear
142			"""
143			return cls.__name__
144
145			@classproperty
146			def can_detect(cls):
147			"""
148			:return: A set that contains everything a bear can detect, gathering
149			information from what it can fix too.
150			"""
151			return cls.CAN_DETECT \| cls.CAN_FIX
152
153			@classproperty
154			def maintainers(cls):
155			"""
156			:return: A set containing ``MAINTAINERS`` if specified, else takes
157			``AUTHORS`` by default.
158			"""
159			return cls.AUTHORS if cls.MAINTAINERS == set() else cls.MAINTAINERS
160
161			@classproperty
162			def maintainers_emails(cls):
163			"""
164			:return: A set containing ``MAINTAINERS_EMAILS`` if specified, else
165			takes ``AUTHORS_EMAILS`` by default.
166			"""
167			return (cls.AUTHORS_EMAILS if cls.MAINTAINERS_EMAILS == set()
168			else cls.MAINTAINERS)
169
170			@enforce_signature
171			def __init__(self,
172			section: Section,
173			message_queue,
174			timeout=0):
175			"""
176			Constructs a new bear.
177
178			:param section: The section object where bear settings are
179			contained.
180			:param message_queue: The queue object for messages. Can be ``None``.
181			:param timeout: The time the bear is allowed to run. To set no
182			time limit, use 0.
183			:raises TypeError: Raised when ``message_queue`` is no queue.
184			:raises RuntimeError: Raised when bear requirements are not fulfilled.
185			"""
186			Printer.__init__(self)
187			LogPrinter.__init__(self, self)
188
189			if message_queue is not None and not hasattr(message_queue, "put"):
190			raise TypeError("message_queue has to be a Queue or None.")
191
192			self.section = section
193			self.message_queue = message_queue
194			self.timeout = timeout
195
196			self.setup_dependencies()
197			cp = type(self).check_prerequisites()
198			if cp is not True:
199			error_string = ("The bear " + self.name +
200			" does not fulfill all requirements.")
201			if cp is not False:
202			error_string += " " + cp
203
204			self.warn(error_string)
205			raise RuntimeError(error_string)
206
207			def _print(self, output, **kwargs):
208			self.debug(output)
209
210			def log_message(self, log_message, timestamp=None, **kwargs):
211			if self.message_queue is not None:
212			self.message_queue.put(log_message)
213
214			def run(self, args, dependency_results=None, *kwargs):
215			raise NotImplementedError
216
217			def run_bear_from_section(self, args, kwargs):
218			try:
219			kwargs.update(
220			self.get_metadata().create_params_from_section(self.section))
221			except ValueError as err:
222			self.warn("The bear {} cannot be executed.".format(
223			self.name), str(err))
224			return
225
226			return self.run(args, *kwargs)
227
228			def execute(self, args, *kwargs):
229			name = self.name
230			try:
231			self.debug("Running bear {}...".format(name))
232			# If it's already a list it won't change it
233			return list(self.run_bear_from_section(args, kwargs) or [])
234			except:
235			self.warn(
236			"Bear {} failed to run. Take a look at debug messages (`-L "
237			"DEBUG`) for further information.".format(name))
238			self.debug(
239			"The bear {bear} raised an exception. If you are the writer "
240			"of this bear, please make sure to catch all exceptions. If "
241			"not and this error annoys you, you might want to get in "
242			"contact with the writer of this bear.\n\nTraceback "
243			"information is provided below:\n\n{traceback}"
244			"\n".format(bear=name, traceback=traceback.format_exc()))
245
246			@staticmethod
247			def kind():
248			"""
249			:return: The kind of the bear
250			"""
251			raise NotImplementedError
252
253			@classmethod
254			def get_metadata(cls):
255			"""
256			:return: Metadata for the run function. However parameters like
257			``self`` or parameters implicitly used by coala (e.g.
258			filename for local bears) are already removed.
259			"""
260			return FunctionMetadata.from_function(
261			cls.run,
262			omit={"self", "dependency_results"})
263
264			@classmethod
265			def __json__(cls):
266			"""
267			Override JSON export of ``Bear`` object.
268			"""
269			_dict = get_public_members(cls)
270			metadata = cls.get_metadata()
271			non_optional_params = metadata.non_optional_params
272			optional_params = metadata.optional_params
273			_dict["metadata"] = {
274			"desc": metadata.desc,
275			"non_optional_params": [({param: non_optional_params[param][0]}
276			for param in non_optional_params)],
277			"optional_params": [({param: optional_params[param][0]}
278			for param in optional_params)]}
279
280			# Delete attributes that cannot be serialized
281			unserializable_attributes = ["new_result", "printer"]
282			for attribute in unserializable_attributes:
283			_dict.pop(attribute, None)
284			return _dict
285
286			@classmethod
287			def missing_dependencies(cls, lst):
288			"""
289			Checks if the given list contains all dependencies.
290
291			:param lst: A list of all already resolved bear classes (not
292			instances).
293			:return: A list of missing dependencies.
294			"""
295			dep_classes = cls.get_dependencies()
296
297			for item in lst:
298			if item in dep_classes:
299			dep_classes.remove(item)
300
301			return dep_classes
302
303			@staticmethod
304			def get_dependencies():
305			"""
306			Retrieves bear classes that are to be executed before this bear gets
307			executed. The results of these bears will then be passed to the
308			run method as a dict via the dependency_results argument. The dict
309			will have the name of the Bear as key and the list of its results as
310			results.
311
312			:return: A list of bear classes.
313			"""
314			return []
315
316			@classmethod
317			def get_non_optional_settings(cls):
318			"""
319			This method has to determine which settings are needed by this bear.
320			The user will be prompted for needed settings that are not available
321			in the settings file so don't include settings where a default value
322			would do.
323
324			:return: A dictionary of needed settings as keys and a tuple of help
325			text and annotation as values
326			"""
327			return cls.get_metadata().non_optional_params
328
329			@staticmethod
330			def setup_dependencies():
331			"""
332			This is a user defined function that can download and set up
333			dependencies (via download_cached_file or arbitary other means) in an OS
334			independent way.
335			"""
336
337			@classmethod
338			def check_prerequisites(cls):
339			"""
340			Checks whether needed runtime prerequisites of the bear are satisfied.
341
342			This function gets executed at construction and returns True by
343			default.
344
345			Section value requirements shall be checked inside the ``run`` method.
346
347			:return: True if prerequisites are satisfied, else False or a string
348			that serves a more detailed description of what's missing.
349			"""
350			return True
351
352			def get_config_dir(self):
353			"""
354			Gives the directory where the configuration file is
355
356			:return: Directory of the config file
357			"""
358			return get_config_directory(self.section)
359
360			def download_cached_file(self, url, filename):
361			"""
362			Downloads the file if needed and caches it for the next time. If a
363			download happens, the user will be informed.
364
365			Take a sane simple bear:
366
367			>>> from queue import Queue
368			>>> bear = Bear(Section("a section"), Queue())
369
370			We can now carelessly query for a neat file that doesn't exist yet:
371
372			>>> from os import remove
373			>>> if exists(join(bear.data_dir, "a_file")):
374			... remove(join(bear.data_dir, "a_file"))
375			>>> file = bear.download_cached_file("http://gitmate.com/", "a_file")
376
377			If we download it again, it'll be much faster as no download occurs:
378
379			>>> newfile = bear.download_cached_file("http://gitmate.com/", "a_file")
380			>>> newfile == file
381			True
382
383			:param url: The URL to download the file from.
384			:param filename: The filename it should get, e.g. "test.txt".
385			:return: A full path to the file ready for you to use!
386			"""
387			filename = join(self.data_dir, filename)
388			if exists(filename):
389			return filename
390
391			self.info("Downloading {filename!r} for bear {bearname} from {url}."
392			.format(filename=filename, bearname=self.name, url=url))
393
394			with urlopen(url) as response, open(filename, 'wb') as out_file:
395			copyfileobj(response, out_file)
396			return filename
397
398			@classproperty
399			def data_dir(cls):
400			"""
401			Returns a directory that may be used by the bear to store stuff. Every
402			bear has an own directory dependent on his name.
403			"""
404			data_dir = abspath(join(user_data_dir('coala-bears'), cls.name))
405
406			makedirs(data_dir, exist_ok=True)
407			return data_dir
408
409			@property
410			def new_result(self):
411			"""
412			Returns a partial for creating a result with this bear already bound.
413			"""
414			return partial(Result.from_values, self)
415

coala-analyzer / coala

Pull Request — master (#2337)

Bear.get_metadata() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like