aboutsummaryrefslogtreecommitdiffstats
path: root/bsfs/front/bsfs.py
blob: 968b3f585f386c0c5582533edf28c31b6a1a4867 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
"""

Part of the BlackStar filesystem (bsfs) module.
A copy of the license is provided with the project.
Author: Matthias Baumgartner, 2022
"""
# imports
import typing

# bsfs imports
from bsfs.graph import Graph

# inner-module imports
from . import builder

# exports
__all__: typing.Sequence[str] = (
    'Open',
    )


## code ##

# NOTE: Capitalized to mark entry point and to separate from builtin open.
def Open(cfg: typing.Any) -> Graph: # pylint: disable=invalid-name
    """Open a BSFS storage and return a `bsfs.graph.Graph` instance."""
    return builder.build_graph(cfg)

## EOF ##