4083580084

Build Type

push

github

Committed by Renata Hodovan

Commit Message

Add API and CLI documentation

Run Details

6 of 6 new or added lines in 2 files covered. (100.0%)

3470 of 4815 relevant lines covered (72.07%)

0.72 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

45.45

/grammarinator/runtime/dispatching_model.py

# Copyright (c) 2020-2023 Renata Hodovan, Akos Kiss.
#
# Licensed under the BSD 3-Clause License
# <LICENSE.rst or https://opensource.org/licenses/BSD-3-Clause>.
# This file may not be copied, modified, or distributed except
# according to those terms.

from .default_model import DefaultModel


class DispatchingModel(DefaultModel):
    """
    Base class of custom modules that aim to override the decisions in
    specific rules. To override a decision point, the subclass must
    define methods in the form of ``choice_{rule_name}``, ``quantify_{rule_name}``
    or ``charset_{rule_name}`` - with the same signature as their counterparts
    in :class:`grammarinator.runtime.DefaultModel` - in case of overriding an
    alternation, quantifier or charset decision, respectively.
    """

    def choice(self, node, idx, weights):
        """
        Trampoline method to call the underlaying model's ``choice_{node.name}`` method if any.
        Otherwise, it calls its anchestor's ``choice`` implementation.
        """
        name = 'choice_' + node.name
        return (getattr(self, name) if hasattr(self, name) else super().choice)(node, idx, weights)

    def quantify(self, node, idx, min, max):
        """
        Trampoline method to call the underlaying model's ``quantify_{node.name}`` method if any.
        Otherwise, it calls its anchestor's ``quantify`` implementation.
        """
        name = 'quantify_' + node.name
        yield from (getattr(self, name) if hasattr(self, name) else super().quantify)(node, idx, min, max)

    def charset(self, node, idx, chars):
        """
        Trampoline method to call the underlaying model's ``charset_{node.name}`` method if any.
        Otherwise, it calls its anchestor's ``charset`` implementation.
        """
        name = 'charset_' + node.name
        return (getattr(self, name) if hasattr(self, name) else super().charset)(node, idx, chars)

1	# Copyright (c) 2020-2023 Renata Hodovan, Akos Kiss.
2	#
3	# Licensed under the BSD 3-Clause License
4	# <LICENSE.rst or https://opensource.org/licenses/BSD-3-Clause>.
5	# This file may not be copied, modified, or distributed except
6	# according to those terms.
7
8	from .default_model import DefaultModel	1✔
9
10
11	class DispatchingModel(DefaultModel):	1✔
12	"""
13	Base class of custom modules that aim to override the decisions in
14	specific rules. To override a decision point, the subclass must
15	define methods in the form of ``choice_{rule_name}``, ``quantify_{rule_name}``
16	or ``charset_{rule_name}`` - with the same signature as their counterparts
17	in :class:`grammarinator.runtime.DefaultModel` - in case of overriding an
18	alternation, quantifier or charset decision, respectively.
19	"""
20
21	def choice(self, node, idx, weights):	1✔
22	"""
23	Trampoline method to call the underlaying model's ``choice_{node.name}`` method if any.
24	Otherwise, it calls its anchestor's ``choice`` implementation.
25	"""
26	name = 'choice_' + node.name	×
27	return (getattr(self, name) if hasattr(self, name) else super().choice)(node, idx, weights)	×
28
29	def quantify(self, node, idx, min, max):	1✔
30	"""
31	Trampoline method to call the underlaying model's ``quantify_{node.name}`` method if any.
32	Otherwise, it calls its anchestor's ``quantify`` implementation.
33	"""
34	name = 'quantify_' + node.name	×
35	yield from (getattr(self, name) if hasattr(self, name) else super().quantify)(node, idx, min, max)	×
36
37	def charset(self, node, idx, chars):	1✔
38	"""
39	Trampoline method to call the underlaying model's ``charset_{node.name}`` method if any.
40	Otherwise, it calls its anchestor's ``charset`` implementation.
41	"""
42	name = 'charset_' + node.name	×
43	return (getattr(self, name) if hasattr(self, name) else super().charset)(node, idx, chars)	×

renatahodovan / grammarinator / 4083580084

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous