FileTools

File Tools Meaning
Filetools Extension

Latest version

Released:

FIT File Tools A collection of useful tools for manipulating FIT files.

What is it XL-FileTools provides a bunch of functions for files, grouped in three categories: Another interesting feature of XL-FileTools is preview mode. You can see what's gonna happen before doing it for real.
The fit file repair tool which I have developed helps you to repair corrupted FIT files and rescue your valuable data. The main features are: import of (corrupted) FIT, TCX and HRM files export as FIT, TCX or HRM file.
Tools to help setup fcl for a grid project. Setup with setup mu2e source an offline setup.sh script setup mu2etools generatefcl. A project may consist of several grid submissions, and each of those submissions may have many jobs.
Download XL-FileTools - Perform various file operations such as listing with custom sets of details, copying and moving, and rename based on hash values or custom parameters.

File Tools Meaning

file processing tools

Project description

This is still very much in progress. Don't use it :-)

Documentation: https://filetools.readthedocs.io
Source: https://github.com/wingechr/filetools
Package: https://pypi.org/project/filetools

Filetools Extension

Release historyRelease notifications | RSS feed

0.0.5

0.0.4

0.0.2

0.0.1

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for filetools, version 0.0.5
Filename, size	File type	Python version	Upload date	Hashes
Filename, size filetools-0.0.5.tar.gz (1.5 kB)	File type Source	Python version None	Upload date	Hashes

Hashes for filetools-0.0.5.tar.gz

Hashes for filetools-0.0.5.tar.gz
Algorithm	Hash digest
SHA256	`9097e3fe44b514f6937e1a71c3cb7332512f8d291c16f9bbdc86c81c0932d164`
MD5	`fa4c13e6ad9af0571f72ec58a48f2765`
BLAKE2-256	`6d17cbe4ea7a16c37b44906acaa7c2609b1558bf47d5e4e5faa0d23efcec2cee`

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`DATA_FOLDER_NAME`
`static String`	`DEVICE_FILE_SUFFIX` Suffix of the device part files
`static String`	`DEVICE_FOLDER_NAME`
`static int[]`	`emptyIntArray` Static empty array to save on memory
`static short[]`	`emptyShortArray`
`static String[]`	`emptyStringArray` Static empty array to save on memory
`static String`	`HDI_PRIMITIVES_FILE_NAME` File name of the EDIF library containing all Uniprims -- Will be removed in 2019.2
`static String`	`IMAGES_FOLDER_NAME`
`static String`	`JARS_FOLDER_NAME` Java library folder name
`static String`	`PART_DB_PATH`
`static String`	`PART_DUMP_FILE_NAME` File name created from Vivado for all supported parts for RapidWright
`static String`	`PYTHON_FOLDER_NAME`
`static String`	`RAPIDWRIGHT_VARIABLE_NAME` Environment Variable Name which points to the RapidWright project on disk
`static String`	`TCL_FOLDER_NAME`
`static String`	`UNISIM_DATA_FILE_NAME` File name of the UnisimManager initialization data file (replaced HDI_PRIMITIVES_FILE_NAME and VALID_CELL_PLACEMENTS_FILE_NAME)
`static String[]`	`UNPACK_FOLDERS` Supporting data folders packed in standalone jars of RapidWright
`static String`	`VALID_CELL_PLACEMENTS_FILE_NAME` File name of containing a kryo compressed map of valid cell placements per family type -- Will be removed in 2019.2

Constructor Summary
Constructors
Constructor and Description
FileTools()

Constructors
Constructor and Description
`FileTools()`

Method Summary

All MethodsStatic MethodsConcrete MethodsDeprecated Methods
Modifier and Type	Method and Description
`static boolean`	`checkIfRapidWrightResourceExists(String name)` Checks if a particular RapidWright file or jar resource exists.
`static void`	`close(InputStream is)`
`static void`	`close(ZipFile zip)`
`static boolean`	`copyFile(String src, String dst)` Copies a file from one location (src) to another (dst).
`static boolean`	`copyFolder(String srcDirectoryPath, String dstDirectoryPath, boolean recursive)` Copies a folder and its files from the path defined in srcDirectoryPath to a new folder at dstDirectoryPath.
`static boolean`	`copyFolderContents(String src, String dst, boolean recursive)` Copies the folder contents of the folder specified by src to folder specified as dst.
`static boolean`	`cygwinInstalled()`
`static boolean`	`deleteFile(String fileName)` Delete the file/folder in the file system called fileName
`static boolean`	`deleteFolder(String folderName)` Delete the folder and recursively files and folders below
`static boolean`	`deleteFolderContents(String path)` Deletes everything in the directory given by path, but does not delete the folder itself.
`static void`	`errorIfFileDoesNotExist(String fileName)` Convenience assertion to assert that a file exists
`static List<String>`	`execCommandGetOutput(boolean includeError, String... command)` Runs the provided command (arguments must be separate) and gathers the standard output followed by the standard error.
`static boolean`	`folderCheck(String name)`
`static List<FamilyType>`	`getAvailableFamilies()` This method returns an ArrayList of family types currently supported
`static List<String>`	`getAvailableParts(FamilyType type)` Checks for all device files present in the current RapidWright family path and returns a list of strings of those part names available to be used by the tool within the specified family.
`static ArrayList<String>`	`getCommandOutput(String[] command)` Generic method to run a command in the current shell and return its standard output and standard error
`static FilenameFilter`	`getDCPFilenameFilter()` Gets a filename filter for DCP files (ends with .dcp).
`static String`	`getDeviceFolderResourceName()`
`static String`	`getDeviceResourceName(Part part)`
`static String`	`getDirectorySeparator()` Gets and returns the file separator character for the given OS
`static FilenameFilter`	`getEDNFilenameFilter()` Gets a filename filter for EDN files (ends with .edn).
`static FilenameFilter`	`getFilenameFilter(String matches)` Creates a custom filename filter that uses the provided matches string on the name of the file (not the path).
`static long`	`getFileSize(String fileName)`
`static InputStream`	`getHDIPrimitivesResourceStream()` Deprecated.
`static InputStream`	`getInputStreamFromZipOrDcpFile(String zipOrDcpFileName, String fileEndsWith)`
`static com.esotericsoftware.kryo.Kryo`	`getKryoInstance()`
`static List<String>`	`getLastNLinesFromTextFile(String fileName, int n)` Gets the last n number of lines from a text file and returns them.
`static ArrayList<String>`	`getLinesFromInputStream(InputStream in)`
`static ArrayList<String>`	`getLinesFromTextFile(String fileName)` This is a simple method that will read in a text file and put each line in a string and put all the lines in an ArrayList.
`static String`	`getOSName()`
`static InputStream`	`getPartDumpResourceStream()` Gets an input stream to the file containing a CSV file of valid parts for RapidWright.
`static String`	`getPartFolderResourceName(FamilyType familyType)` Gets and returns the path of the folder where the family type resides.
`static String`	`getPartFolderResourceName(Part part)` Gets and returns the path of the folder where the part files resides for deviceName.
`static BufferedReader`	`getProperInputStream(String fileName)` Creates a BufferedReader that reads an input file and determines based on file extension (*.gz) if the file is gzipped or not.
`static BufferedWriter`	`getProperOutputStream(String fileName)` Creates a new BufferedWriter that will either write out text or a gzipped compressed version of text based on the file extension (*.gz -> gzipped, all others target an uncompressed output.
`static String`	`getRapidWrightPath()` Gets and returns the value of the environment variable RAPIDWRIGHT_PATH.
`static String`	`getRapidWrightResourceFileName(String name)` Finds and returns a file name that can be read for the corresponding RapidWright resource.
`static InputStream`	`getRapidWrightResourceInputStream(String name)` Identifies the proper location for a RapidWright data resource and returns an opened InputStream to that resource.
`static String`	`getTimeString()` This method will get and return the current time as a string formatted in the same way used in most Xilinx report and XDL files.
`static String`	`getUniqueProcessAndHostID()`
`static InputStream`	`getUnisimDataResourceStream()` Gets an input stream to the file containing valid cell placements of the hdi primitives.
`static com.esotericsoftware.kryo.unsafe.UnsafeInput`	`getUnsafeInputStream(InputStream in)`
`static com.esotericsoftware.kryo.unsafe.UnsafeInput`	`getUnsafeInputStream(String fileName)`
`static com.esotericsoftware.kryo.unsafe.UnsafeOutput`	`getUnsafeOutputStream(OutputStream os)`
`static com.esotericsoftware.kryo.unsafe.UnsafeOutput`	`getUnsafeOutputStream(String fileName)`
`static InputStream`	`getValidCellPlacementsResourceStream()`
`static String`	`getVivadoPath()` Gets the full path to the vivado executable if it is set in the PATH environment variable.
`static boolean`	`isDataBinary(InputStream is)`
`static boolean`	`isExecutableOnPath(String execName)` Checks if a particular executable is available on the current path
`static boolean`	`isFileBinary(String fileName)` Uses a similar algorithm to diff to determine if the file is a binary file by looking at the first 4k bytes to see if there are any null characters.
`static boolean`	`isFileNewer(String fileName1, String fileName2)`
`static boolean`	`isVivadoCompatible()` Checks that Vivado is on current PATH and returns true if RapidWright should be compatible with the version of vivado available.
`static boolean`	`isVivadoOnPath()` Checks if vivado is available on current PATH (uses unix 'which' or windows 'where').
`static boolean`	`isWindows()`
`static Object`	`loadFromFile(String fileName)`
`static void`	`main(String[] args)`
`static boolean`	`makeDir(String dirName)` Creates a directory in the current path called dirName.
`static boolean`	`makeDirs(String dirName)` Creates a directory in the current path called dirName.
`static HashMap<String,Integer>`	`readHashMap(com.esotericsoftware.kryo.unsafe.UnsafeInput dis, Integer[] allInts)`
`static int[]`	`readIntArray(com.esotericsoftware.kryo.unsafe.UnsafeInput dis)`
`static <T> T`	`readObjectFromKryoFile(InputStream in, Class<T> c)`
`static Object`	`readObjectFromKryoFile(String fileName)`
`static <T> T`	`readObjectFromKryoFile(String fileName, Class<T> c)`
`static short[]`	`readShortArray(com.esotericsoftware.kryo.unsafe.UnsafeInput dis)`
`static String`	`readString(DataInputStream dis)`
`static String[]`	`readStringArray(com.esotericsoftware.kryo.unsafe.UnsafeInput dis)`
`static String`	`removeFileExtension(String fileName)` Takes a file name and removes everything after the last '.' inclusive
`static boolean`	`renameFile(String oldFileName, String newFileName)`
`static Integer`	`runCommand(List<String> command, String logFileName)` A generic method to run a command from the system command line.
`static Integer`	`runCommand(String command, boolean verbose)` A generic method to run a command from the system command line.
`static boolean`	`saveToFile(Object o, String fileName)` Serialize the Object o to a the file specified by fileName.
`static boolean`	`unPackSupportingJarData()` Used for unpacking data files inside a standalone jar to be used for regular use by RapidWright.
`static void`	`unzipFile(String zipFileName, String destDirectory)`
`static boolean`	`writeHashMap(com.esotericsoftware.kryo.unsafe.UnsafeOutput dos, HashMap<String,Integer> map)`
`static boolean`	`writeIntArray(com.esotericsoftware.kryo.unsafe.UnsafeOutput dos, int[] intArray)`
`static void`	`writeLinesToTextFile(List<String> lines, String fileName)` This is a simple method that writes the elements of an ArrayList of Strings into lines in the text file fileName.
`static void`	`writeObjectToKryoFile(String fileName, Object o)`
`static void`	`writeObjectToKryoFile(String fileName, Object o, boolean writeClass)`
`static boolean`	`writeShortArray(com.esotericsoftware.kryo.unsafe.UnsafeOutput dos, short[] intArray)`
`static boolean`	`writeString(DataOutputStream dos, String str)`
`static boolean`	`writeStringArray(com.esotericsoftware.kryo.unsafe.UnsafeOutput dos, String[] stringArray)`
`static void`	`writeStringToTextFile(String text, String fileName)` This is a simple method that writes a String to a file and adds a new line.

Methods inherited from class Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait