Skip to content

Filesystem

File system operations for Logseq Analyzer.

Classes:

Name Description
File

A class to represent a file in the Logseq Analyzer.
OutputDirectory

Class to handle the output directory for the Logseq Analyzer.
LogFile

Class to handle the log file for the Logseq Analyzer.
GraphDirectory

Class to handle the graph directory for the Logseq Analyzer.
LogseqDirectory

Class to handle the Logseq directory for the Logseq Analyzer.
ConfigFile

Class to handle the config file for the Logseq Analyzer.
DeleteDirectory

Class to handle the delete directory for the Logseq Analyzer.
DeleteBakDirectory

Class to handle the delete bak directory for the Logseq Analyzer.
DeleteRecycleDirectory

Class to handle the delete recycle directory for the Logseq Analyzer.
DeleteAssetsDirectory

Class to handle the delete assets directory for the Logseq Analyzer.
CacheFile

Class to handle the cache file for the Logseq Analyzer.
BakDirectory

Class to handle the bak directory for the Logseq Analyzer.
RecycleDirectory

Class to handle the recycle directory for the Logseq Analyzer.
GlobalConfigFile

Class to handle the global config file for the Logseq Analyzer.
AssetsDirectory

Class to handle the assets directory for the Logseq Analyzer.
DrawsDirectory

Class to handle the draws directory for the Logseq Analyzer.
JournalsDirectory

Class to handle the journals directory for the Logseq Analyzer.
PagesDirectory

Class to handle the pages directory for the Logseq Analyzer.
WhiteboardsDirectory

Class to handle the whiteboards directory for the Logseq Analyzer.
LogseqGraphDirs

Directories related to the Logseq graph.
AnalyzerDeleteDirs

Directories for deletion operations in the Logseq analyzer.
LogseqAnalyzerDirs

Directories used by the Logseq analyzer.

File(path: Path, clean_on_init: bool = False, must_exist: bool = False, is_dir: bool = False) dataclass

A class to represent a file in the Logseq Analyzer.

Methods:

Name Description
__post_init__

Initialize the File class with a path.
startup

Perform startup operations for the File object.
validate

Validate the file path.
clean

Clean up the file or directory.
make_if_missing

Create the file or directory if it does not exist.

__post_init__() -> None

Initialize the File class with a path.

startup() -> None

Perform startup operations for the File object.

validate() -> None

Validate the file path.

clean() -> None

Clean up the file or directory.

make_if_missing() -> None

Create the file or directory if it does not exist.

OutputDirectory(path: Path, clean_on_init: bool = False, must_exist: bool = False, is_dir: bool = False) dataclass

Bases: File

Class to handle the output directory for the Logseq Analyzer.

Methods:

Name Description
__post_init__

Post-initialization for OutputDirectory.
startup

Perform startup operations for the File object.
validate

Validate the file path.
clean

Clean up the file or directory.
make_if_missing

Create the file or directory if it does not exist.

__post_init__() -> None

Post-initialization for OutputDirectory.

startup() -> None

Perform startup operations for the File object.

validate() -> None

Validate the file path.

clean() -> None

Clean up the file or directory.

make_if_missing() -> None

Create the file or directory if it does not exist.

LogFile(path: Path, clean_on_init: bool = False, must_exist: bool = False, is_dir: bool = False) dataclass

Bases: File

Class to handle the log file for the Logseq Analyzer.

Methods:

Name Description
__post_init__

Post-initialization for LogFile.
startup

Perform startup operations for the File object.
validate

Validate the file path.
clean

Clean up the file or directory.
make_if_missing

Create the file or directory if it does not exist.

__post_init__() -> None

Post-initialization for LogFile.

startup() -> None

Perform startup operations for the File object.

validate() -> None

Validate the file path.

clean() -> None

Clean up the file or directory.

make_if_missing() -> None

Create the file or directory if it does not exist.

GraphDirectory(path: Path, clean_on_init: bool = False, must_exist: bool = False, is_dir: bool = False) dataclass

Bases: File

Class to handle the graph directory for the Logseq Analyzer.

Methods:

Name Description
__post_init__

Post-initialization for GraphDirectory.
startup

Perform startup operations for the File object.
validate

Validate the file path.
clean

Clean up the file or directory.
make_if_missing

Create the file or directory if it does not exist.

__post_init__() -> None

Post-initialization for GraphDirectory.

startup() -> None

Perform startup operations for the File object.

validate() -> None

Validate the file path.

clean() -> None

Clean up the file or directory.

make_if_missing() -> None

Create the file or directory if it does not exist.

LogseqDirectory(path: Path, clean_on_init: bool = False, must_exist: bool = False, is_dir: bool = False) dataclass

Bases: File

Class to handle the Logseq directory for the Logseq Analyzer.

Methods:

Name Description
__post_init__

Post-initialization for LogseqDirectory.
startup

Perform startup operations for the File object.
validate

Validate the file path.
clean

Clean up the file or directory.
make_if_missing

Create the file or directory if it does not exist.

__post_init__() -> None

Post-initialization for LogseqDirectory.

startup() -> None

Perform startup operations for the File object.

validate() -> None

Validate the file path.

clean() -> None

Clean up the file or directory.

make_if_missing() -> None

Create the file or directory if it does not exist.

ConfigFile(path: Path, clean_on_init: bool = False, must_exist: bool = False, is_dir: bool = False) dataclass

Bases: File

Class to handle the config file for the Logseq Analyzer.

Methods:

Name Description
__post_init__

Post-initialization for ConfigFile.
startup

Perform startup operations for the File object.
validate

Validate the file path.
clean

Clean up the file or directory.
make_if_missing

Create the file or directory if it does not exist.

__post_init__() -> None

Post-initialization for ConfigFile.

startup() -> None

Perform startup operations for the File object.

validate() -> None

Validate the file path.

clean() -> None

Clean up the file or directory.

make_if_missing() -> None

Create the file or directory if it does not exist.

DeleteDirectory(path: Path, clean_on_init: bool = False, must_exist: bool = False, is_dir: bool = False) dataclass

Bases: File

Class to handle the delete directory for the Logseq Analyzer.

Methods:

Name Description
__post_init__

Post-initialization for DeleteDirectory.
startup

Perform startup operations for the File object.
validate

Validate the file path.
clean

Clean up the file or directory.
make_if_missing

Create the file or directory if it does not exist.

__post_init__() -> None

Post-initialization for DeleteDirectory.

startup() -> None

Perform startup operations for the File object.

validate() -> None

Validate the file path.

clean() -> None

Clean up the file or directory.

make_if_missing() -> None

Create the file or directory if it does not exist.

DeleteBakDirectory(path: Path, clean_on_init: bool = False, must_exist: bool = False, is_dir: bool = False) dataclass

Bases: File

Class to handle the delete bak directory for the Logseq Analyzer.

Methods:

Name Description
__post_init__

Post-initialization for DeleteBakDirectory.
startup

Perform startup operations for the File object.
validate

Validate the file path.
clean

Clean up the file or directory.
make_if_missing

Create the file or directory if it does not exist.

__post_init__() -> None

Post-initialization for DeleteBakDirectory.

startup() -> None

Perform startup operations for the File object.

validate() -> None

Validate the file path.

clean() -> None

Clean up the file or directory.

make_if_missing() -> None

Create the file or directory if it does not exist.

DeleteRecycleDirectory(path: Path, clean_on_init: bool = False, must_exist: bool = False, is_dir: bool = False) dataclass

Bases: File

Class to handle the delete recycle directory for the Logseq Analyzer.

Methods:

Name Description
__post_init__

Post-initialization for DeleteRecycleDirectory.
startup

Perform startup operations for the File object.
validate

Validate the file path.
clean

Clean up the file or directory.
make_if_missing

Create the file or directory if it does not exist.

__post_init__() -> None

Post-initialization for DeleteRecycleDirectory.

startup() -> None

Perform startup operations for the File object.

validate() -> None

Validate the file path.

clean() -> None

Clean up the file or directory.

make_if_missing() -> None

Create the file or directory if it does not exist.

DeleteAssetsDirectory(path: Path, clean_on_init: bool = False, must_exist: bool = False, is_dir: bool = False) dataclass

Bases: File

Class to handle the delete assets directory for the Logseq Analyzer.

Methods:

Name Description
__post_init__

Post-initialization for DeleteAssetsDirectory.
startup

Perform startup operations for the File object.
validate

Validate the file path.
clean

Clean up the file or directory.
make_if_missing

Create the file or directory if it does not exist.

__post_init__() -> None

Post-initialization for DeleteAssetsDirectory.

startup() -> None

Perform startup operations for the File object.

validate() -> None

Validate the file path.

clean() -> None

Clean up the file or directory.

make_if_missing() -> None

Create the file or directory if it does not exist.

CacheFile(path: Path, clean_on_init: bool = False, must_exist: bool = False, is_dir: bool = False) dataclass

Bases: File

Class to handle the cache file for the Logseq Analyzer.

Methods:

Name Description
__post_init__

Post-initialization for CacheFile.
startup

Perform startup operations for the File object.
validate

Validate the file path.
clean

Clean up the file or directory.
make_if_missing

Create the file or directory if it does not exist.

__post_init__() -> None

Post-initialization for CacheFile.

startup() -> None

Perform startup operations for the File object.

validate() -> None

Validate the file path.

clean() -> None

Clean up the file or directory.

make_if_missing() -> None

Create the file or directory if it does not exist.

BakDirectory(path: Path, clean_on_init: bool = False, must_exist: bool = False, is_dir: bool = False) dataclass

Bases: File

Class to handle the bak directory for the Logseq Analyzer.

Methods:

Name Description
__post_init__

Post-initialization for BakDirectory.
startup

Perform startup operations for the File object.
validate

Validate the file path.
clean

Clean up the file or directory.
make_if_missing

Create the file or directory if it does not exist.

__post_init__() -> None

Post-initialization for BakDirectory.

startup() -> None

Perform startup operations for the File object.

validate() -> None

Validate the file path.

clean() -> None

Clean up the file or directory.

make_if_missing() -> None

Create the file or directory if it does not exist.

RecycleDirectory(path: Path, clean_on_init: bool = False, must_exist: bool = False, is_dir: bool = False) dataclass

Bases: File

Class to handle the recycle directory for the Logseq Analyzer.

Methods:

Name Description
__post_init__

Post-initialization for RecycleDirectory.
startup

Perform startup operations for the File object.
validate

Validate the file path.
clean

Clean up the file or directory.
make_if_missing

Create the file or directory if it does not exist.

__post_init__() -> None

Post-initialization for RecycleDirectory.

startup() -> None

Perform startup operations for the File object.

validate() -> None

Validate the file path.

clean() -> None

Clean up the file or directory.

make_if_missing() -> None

Create the file or directory if it does not exist.

GlobalConfigFile(path: Path, clean_on_init: bool = False, must_exist: bool = False, is_dir: bool = False) dataclass

Bases: File

Class to handle the global config file for the Logseq Analyzer.

Methods:

Name Description
__post_init__

Post-initialization for GlobalConfigFile.
startup

Perform startup operations for the File object.
validate

Validate the file path.
clean

Clean up the file or directory.
make_if_missing

Create the file or directory if it does not exist.

__post_init__() -> None

Post-initialization for GlobalConfigFile.

startup() -> None

Perform startup operations for the File object.

validate() -> None

Validate the file path.

clean() -> None

Clean up the file or directory.

make_if_missing() -> None

Create the file or directory if it does not exist.

AssetsDirectory(path: Path, clean_on_init: bool = False, must_exist: bool = False, is_dir: bool = False) dataclass

Bases: File

Class to handle the assets directory for the Logseq Analyzer.

Methods:

Name Description
__post_init__

Post-initialization for AssetsDirectory.
startup

Perform startup operations for the File object.
validate

Validate the file path.
clean

Clean up the file or directory.
make_if_missing

Create the file or directory if it does not exist.

__post_init__() -> None

Post-initialization for AssetsDirectory.

startup() -> None

Perform startup operations for the File object.

validate() -> None

Validate the file path.

clean() -> None

Clean up the file or directory.

make_if_missing() -> None

Create the file or directory if it does not exist.

DrawsDirectory(path: Path, clean_on_init: bool = False, must_exist: bool = False, is_dir: bool = False) dataclass

Bases: File

Class to handle the draws directory for the Logseq Analyzer.

Methods:

Name Description
__post_init__

Post-initialization for DrawsDirectory.
startup

Perform startup operations for the File object.
validate

Validate the file path.
clean

Clean up the file or directory.
make_if_missing

Create the file or directory if it does not exist.

__post_init__() -> None

Post-initialization for DrawsDirectory.

startup() -> None

Perform startup operations for the File object.

validate() -> None

Validate the file path.

clean() -> None

Clean up the file or directory.

make_if_missing() -> None

Create the file or directory if it does not exist.

JournalsDirectory(path: Path, clean_on_init: bool = False, must_exist: bool = False, is_dir: bool = False) dataclass

Bases: File

Class to handle the journals directory for the Logseq Analyzer.

Methods:

Name Description
__post_init__

Post-initialization for JournalsDirectory.
startup

Perform startup operations for the File object.
validate

Validate the file path.
clean

Clean up the file or directory.
make_if_missing

Create the file or directory if it does not exist.

__post_init__() -> None

Post-initialization for JournalsDirectory.

startup() -> None

Perform startup operations for the File object.

validate() -> None

Validate the file path.

clean() -> None

Clean up the file or directory.

make_if_missing() -> None

Create the file or directory if it does not exist.

PagesDirectory(path: Path, clean_on_init: bool = False, must_exist: bool = False, is_dir: bool = False) dataclass

Bases: File

Class to handle the pages directory for the Logseq Analyzer.

Methods:

Name Description
__post_init__

Post-initialization for PagesDirectory.
startup

Perform startup operations for the File object.
validate

Validate the file path.
clean

Clean up the file or directory.
make_if_missing

Create the file or directory if it does not exist.

__post_init__() -> None

Post-initialization for PagesDirectory.

startup() -> None

Perform startup operations for the File object.

validate() -> None

Validate the file path.

clean() -> None

Clean up the file or directory.

make_if_missing() -> None

Create the file or directory if it does not exist.

WhiteboardsDirectory(path: Path, clean_on_init: bool = False, must_exist: bool = False, is_dir: bool = False) dataclass

Bases: File

Class to handle the whiteboards directory for the Logseq Analyzer.

Methods:

Name Description
__post_init__

Post-initialization for WhiteboardsDirectory.
startup

Perform startup operations for the File object.
validate

Validate the file path.
clean

Clean up the file or directory.
make_if_missing

Create the file or directory if it does not exist.

__post_init__() -> None

Post-initialization for WhiteboardsDirectory.

startup() -> None

Perform startup operations for the File object.

validate() -> None

Validate the file path.

clean() -> None

Clean up the file or directory.

make_if_missing() -> None

Create the file or directory if it does not exist.

LogseqGraphDirs(graph_dir: GraphDirectory, logseq_dir: LogseqDirectory, bak_dir: BakDirectory, recycle_dir: RecycleDirectory, user_config: ConfigFile, global_config: GlobalConfigFile | None = None) dataclass

Directories related to the Logseq graph.

Attributes:

Name Type Description
report dict[DirsGraph, Any]

Generate a report of the Logseq graph directories.

report: dict[DirsGraph, Any] property

Generate a report of the Logseq graph directories.

AnalyzerDeleteDirs() dataclass

Directories for deletion operations in the Logseq analyzer.

Methods:

Name Description
__post_init__

Initialize the AnalyzerDeleteDirs class.

Attributes:

Name Type Description
report dict[DirsDelete, Any]

Generate a report of the analyzer delete directories.

report: dict[DirsDelete, Any] property

Generate a report of the analyzer delete directories.

__post_init__() -> None

Initialize the AnalyzerDeleteDirs class.

LogseqAnalyzerDirs(graph_dirs: LogseqGraphDirs, delete_dirs: AnalyzerDeleteDirs, target_dirs: dict[str, str], output_dir: OutputDirectory) dataclass

Directories used by the Logseq analyzer.

Attributes:

Name Type Description
report dict[DirsAnalyzer, dict[DirsAnalyzer, Any]]

Generate a report of the Logseq analyzer directories.

report: dict[DirsAnalyzer, dict[DirsAnalyzer, Any]] property

Generate a report of the Logseq analyzer directories.