Skip to content

synt.expr.modpath ¤

path module-attribute ¤

1
path = ModPath

Alias ModPath.

ModPath ¤

Bases: IntoCode

Module path.

Examples:

1
2
3
4
5
6
7
8
p = path(id_('foo'))
assert p.into_code() == "foo"
p = path(id_('foo'), id_('bar'))
assert p.into_code() == "foo.bar"
p = path(id_('foo'), id_('bar'), depth=3)
assert p.into_code() == "...foo.bar"
p = path(id_('foo'), id_('bar')).dep(4)
assert p.into_code() == "....foo.bar"
Source code in synt/expr/modpath.py 
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
class ModPath(IntoCode):
    r"""Module path.

    Examples:
        ```python
        p = path(id_('foo'))
        assert p.into_code() == "foo"
        p = path(id_('foo'), id_('bar'))
        assert p.into_code() == "foo.bar"
        p = path(id_('foo'), id_('bar'), depth=3)
        assert p.into_code() == "...foo.bar"
        p = path(id_('foo'), id_('bar')).dep(4)
        assert p.into_code() == "....foo.bar"
        ```
    """

    names: list[Identifier]
    """Names of the path."""
    depth: int
    """Relative depth of the path."""

    def __init__(self, *names: Identifier, depth: int = 0):
        """Initialize a new module path.

        Args:
            names: Names of the path.
            depth: Relative depth of the path.
        """
        self.names = list(names)
        self.depth = depth

    def dep(self, depth: int) -> Self:
        """Set the depth of the path.

        Args:
            depth: New depth of the path.
        """
        self.depth = depth
        return self

    def into_code(self) -> str:
        return "." * self.depth + ".".join(name.into_code() for name in self.names)

    def as_(self, asname: Identifier) -> Alias:
        """Alias the import path.

        Args:
            asname: Name of the alias.
        """
        from synt.expr.alias import Alias

        return Alias(self, asname)

names instance-attribute ¤

1

Names of the path.

depth instance-attribute ¤

1
depth: int = depth

Relative depth of the path.

__init__ ¤

1
__init__(*names: Identifier, depth: int = 0)

Initialize a new module path.

Parameters:

Name Type Description Default
names Identifier

Names of the path.

 ()
depth int

Relative depth of the path.

 0
Source code in synt/expr/modpath.py 
44
45
46
47
48
49
50
51
52
def __init__(self, *names: Identifier, depth: int = 0):
    """Initialize a new module path.

    Args:
        names: Names of the path.
        depth: Relative depth of the path.
    """
    self.names = list(names)
    self.depth = depth

dep ¤

1
dep(depth: int) -> Self

Set the depth of the path.

Parameters:

Name Type Description Default
depth int

New depth of the path.

 required
Source code in synt/expr/modpath.py 
54
55
56
57
58
59
60
61
def dep(self, depth: int) -> Self:
    """Set the depth of the path.

    Args:
        depth: New depth of the path.
    """
    self.depth = depth
    return self

into_code ¤

1
into_code() -> str
Source code in synt/expr/modpath.py 
63
64
def into_code(self) -> str:
    return "." * self.depth + ".".join(name.into_code() for name in self.names)

as_ ¤

1
as_(asname: Identifier) -> Alias

Alias the import path.

Parameters:

Name Type Description Default
asname Identifier

Name of the alias.

 required
Source code in synt/expr/modpath.py 
66
67
68
69
70
71
72
73
74
def as_(self, asname: Identifier) -> Alias:
    """Alias the import path.

    Args:
        asname: Name of the alias.
    """
    from synt.expr.alias import Alias

    return Alias(self, asname)

relpath ¤

1
relpath(*names: Identifier) -> ModPath

Initialize a path relatively (depth = 1).

Parameters:

Name Type Description Default
names Identifier

Names of the path.

 ()

Examples:

1
2
r = relpath(id_("abc"))
assert r.into_code() == ".abc"
Source code in synt/expr/modpath.py 
81
82
83
84
85
86
87
88
89
90
91
92
93
def relpath(*names: Identifier) -> ModPath:
    r"""Initialize a path relatively (`depth = 1`).

    Args:
        names: Names of the path.

    Examples:
        ```python
        r = relpath(id_("abc"))
        assert r.into_code() == ".abc"
        ```
    """
    return ModPath(*names, depth=1)

parentpath ¤

1
parentpath(*names: Identifier) -> ModPath

Initialize a path from its parent (depth = 2).

Parameters:

Name Type Description Default
names Identifier

Names of the path.

 ()

Examples:

1
2
r = parentpath(id_("abc"))
assert r.into_code() == "..abc"
Source code in synt/expr/modpath.py 
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
def parentpath(*names: Identifier) -> ModPath:
    r"""Initialize a path from its parent (`depth = 2`).

    Args:
        names: Names of the path.

    Examples:
        ```python
        r = parentpath(id_("abc"))
        assert r.into_code() == "..abc"
        ```
    """
    return ModPath(*names, depth=2)