Skip to content

DictFile

Dictionary File

Implements an iterable file format that handles the RADIUS $INCLUDE directives behind the scene.

DictFile

Dictionary file class

An iterable file type that handles $INCLUDE directives internally.

Source code in pyrad2/dictfile.py 
 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
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
class DictFile:
    """Dictionary file class

    An iterable file type that handles $INCLUDE
    directives internally.
    """

    __slots__ = "stack"

    def __init__(self, fil: str | io.TextIOWrapper) -> None:
        """
        @param fil: a dictionary file to parse
        @type fil: string or file
        """
        self.stack: list[_Node] = []
        self.__ReadNode(fil)

    def __ReadNode(self, fil: str | io.TextIOWrapper) -> None:
        parentdir = self.__CurDir()
        if isinstance(fil, str):
            if os.path.isabs(fil):
                fname = fil
            else:
                fname = os.path.join(parentdir, fil)
            fd = open(fname)
            node = _Node(fd, fil, parentdir)
            fd.close()
        else:
            node = _Node(fil, "", parentdir)
        self.stack.append(node)

    def __CurDir(self) -> str:
        if self.stack:
            return self.stack[-1].dir
        else:
            return os.path.realpath(os.curdir)

    def __GetInclude(self, line: str) -> Optional[str]:
        line = line.split("#", 1)[0].strip()
        tokens = line.split()
        if tokens and tokens[0].upper() == "$INCLUDE":
            return " ".join(tokens[1:])
        else:
            return None

    def Line(self) -> int:
        """Returns line number of current file"""
        if self.stack:
            return self.stack[-1].current
        else:
            return -1

    def File(self) -> str:
        """Returns name of current file"""
        if self.stack:
            return self.stack[-1].name
        else:
            return ""

    def __iter__(self) -> Self:
        return self

    def __next__(self) -> str:
        while self.stack:
            line = self.stack[-1].Next()
            if line is None:
                self.stack.pop()
            else:
                inc = self.__GetInclude(line)
                if inc:
                    self.__ReadNode(inc)
                else:
                    return line
        raise StopIteration

    next = __next__  # BBB for python <3

__init__(fil)

@param fil: a dictionary file to parse @type fil: string or file

Source code in pyrad2/dictfile.py 
47
48
49
50
51
52
53
def __init__(self, fil: str | io.TextIOWrapper) -> None:
    """
    @param fil: a dictionary file to parse
    @type fil: string or file
    """
    self.stack: list[_Node] = []
    self.__ReadNode(fil)

Line()

Returns line number of current file

Source code in pyrad2/dictfile.py 
83
84
85
86
87
88
def Line(self) -> int:
    """Returns line number of current file"""
    if self.stack:
        return self.stack[-1].current
    else:
        return -1

File()

Returns name of current file

Source code in pyrad2/dictfile.py 
90
91
92
93
94
95
def File(self) -> str:
    """Returns name of current file"""
    if self.stack:
        return self.stack[-1].name
    else:
        return ""