spinn_utilities.make_tools package¶
Submodules¶
spinn_utilities.make_tools.converter module¶
- spinn_utilities.make_tools.converter.convert(src: str, dest: str, new_dict: bool) None [source]¶
Converts a whole directory including sub-directories.
- Parameters:
src – Full source directory
dest – Full destination directory
new_dict – Whether we should generate a new dictionary/DB. If not, we add to the existing one.
spinn_utilities.make_tools.log_sqllite_database module¶
- class spinn_utilities.make_tools.log_sqllite_database.LogSqlLiteDatabase(new_dict: bool = False)[source]¶
Bases:
AbstractContextManager
Specific implementation of the Database for SQLite 3.
Note
Not thread-safe on the same database. Threads can access different DBs just fine.
Note
This totally relies on the way SQLite’s type affinities function. You can’t port to a different database engine without a lot of work.
Connects to a log dict. The location of the file can be overridden using the
C_LOGS_DICT
environment variable.- Parameters:
new_dict (bool) – Flag to say if this is a new dict or not. If True, clears and previous values. If False, makes sure the dict exists.
- check_original(original: str) None [source]¶
Checks that an original log line has been added to the database.
Mainly used for testing
- Parameters:
original
- Raises:
ValueError – If the original is not in the database
- get_directory_id(src_path: str, dest_path: str) int [source]¶
gets the Ids for this directory. Making a new one if needed
- Parameters:
src_path
dest_path
- get_file_id(directory_id: int, file_name: str) int [source]¶
Gets the id for this file, making a new one if needed.
- Parameters:
directory_id
file_name
spinn_utilities.make_tools.replacer module¶
- class spinn_utilities.make_tools.replacer.Replacer(new_dict: bool = False)[source]¶
Bases:
LogSqlLiteDatabase
Performs replacements.
Connects to a log dict. The location of the file can be overridden using the
C_LOGS_DICT
environment variable.- Parameters:
new_dict (bool) – Flag to say if this is a new dict or not. If True, clears and previous values. If False, makes sure the dict exists.
Module contents¶
- class spinn_utilities.make_tools.FileConverter[source]¶
Bases:
object
Converts a file. See
convert()
.- static convert(src_dir: str, dest_dir: str, file_name: str) None [source]¶
Static method to create Object and do the conversion.
- Parameters:
src_dir – Source directory
dest_dir – Destination directory
file_name – The name of the file to convert within the source directory; it will be made with the same name in the destination directory.