File Utility
Utility functions for the file system.
Quick Facts
| Property | Value |
|---|---|
| Class | FileUtility |
| Module | cenpylib.FileUtility |
| Package | cenpylib |
| Release | R2025.2.4 |
| Methods | 13 |
Quick Start
# Boilerplate Example
fileUtility = ... # obtained from the runtime context
result = fileUtility.GetWindowsUserName()Method Index
| Method | Returns | Summary |
|---|---|---|
GetWindowsUserName | โ | Get a name of the windows user. |
GetCurrentDateAndTime | โ | Get a date and time in the specified format. |
GetFilenameWithoutExtension | โ | โGet the name of the file without extension from the given file path. |
CopyDirectoryRecursively | โ | Recursively copy an entire directory tree to the given location. |
CopyFileToDirectory | โ | Copy a source file to the destination directory. |
CopyMultipleFilesToDirectory | โ | Copy a multiple source files to the destination directory. |
CutAndPaste | โ | Recursively move a file or an entire directory tree to the given location. |
RemoveDirectory | โ | Delete an entire directory tree, path must point to a directory. |
AppendTextToFile | โ | Open a text file, append the given text and close it. |
AppendTextArrayToFile | โ | Open a text file, append the given text array and close it. |
ReadCSVColumnIntoList | โ | Read the CSV file and return the specified column as a list. |
GetFilesAndDirectoriesRecursively | โ | Recursively gets all files and all directories inside the given directory. |
RunWinMerge | โ | Call the WinMerge to compare original and modified files. |
Query Methods
GetWindowsUserName
def GetWindowsUserName()Get a name of the windows user.
GetCurrentDateAndTime
def GetCurrentDateAndTime(format='%d.%m.%Y %H:%M:%S')Get a date and time in the specified format.
Parameters:
| Name | Type | Description |
|---|---|---|
format | โ | โ (default: '%d.%m.%Y %H:%M:%S') |
GetFilenameWithoutExtension
def GetFilenameWithoutExtension(filePath)โGet the name of the file without extension from the given file path.
Parameters:
| Name | Type | Description |
|---|---|---|
filePath | โ | โ |
ReadCSVColumnIntoList
def ReadCSVColumnIntoList(filePath, columnName)Read the CSV file and return the specified column as a list.
Parameters:
| Name | Type | Description |
|---|---|---|
filePath | โ | โ |
columnName | โ | โ |
GetFilesAndDirectoriesRecursively
def GetFilesAndDirectoriesRecursively(directoryPath)Recursively gets all files and all directories inside the given directory.
Parameters:
| Name | Type | Description |
|---|---|---|
directoryPath | โ | โ |
Mutation Methods
RemoveDirectory
def RemoveDirectory(directoryPath, ignoreErrors=True)Delete an entire directory tree, path must point to a directory.
Parameters:
| Name | Type | Description |
|---|---|---|
directoryPath | โ | โ |
ignoreErrors | โ | โ (default: True) |
Execution & Actions
RunWinMerge
def RunWinMerge(winMergePath, leftFilePath, rightFilePath, reportFilePath=None, readonly=True, inBackground=False, useDefaultSettings=False)Call the WinMerge to compare original and modified files.
Parameters:
| Name | Type | Description |
|---|---|---|
winMergePath | โ | โ |
leftFilePath | โ | โ |
rightFilePath | โ | โ |
reportFilePath | โ | โ (default: None) |
readonly | โ | โ (default: True) |
inBackground | โ | โ (default: False) |
useDefaultSettings | โ | โ (default: False) |
Conversion & Serialization
CopyDirectoryRecursively
def CopyDirectoryRecursively(sourceDirectory, destinationDirectory)Recursively copy an entire directory tree to the given location. Create the destination directory if it does not exist. Replace the destination directory if it exists.
Parameters:
| Name | Type | Description |
|---|---|---|
sourceDirectory | โ | โ |
destinationDirectory | โ | โ |
CopyFileToDirectory
def CopyFileToDirectory(sourceFile, destinationDirectory)Copy a source file to the destination directory. Create the destination directory if it does not exist. Replace the destination file if it exists.
Parameters:
| Name | Type | Description |
|---|---|---|
sourceFile | โ | โ |
destinationDirectory | โ | โ |
CopyMultipleFilesToDirectory
def CopyMultipleFilesToDirectory(sourceFiles, destinationDirectory)Copy a multiple source files to the destination directory. Create the destination directory if it does not exist. Replace the destination files if they exist.
Parameters:
| Name | Type | Description |
|---|---|---|
sourceFiles | โ | โ |
destinationDirectory | โ | โ |
Utilities
CutAndPaste
def CutAndPaste(source, destinationDirectory)Recursively move a file or an entire directory tree to the given location. Create the destination directory if it does not exist. Replace the destination directory if it exists.
Parameters:
| Name | Type | Description |
|---|---|---|
source | โ | โ |
destinationDirectory | โ | โ |
AppendTextToFile
def AppendTextToFile(filePath, text)Open a text file, append the given text and close it. Create a new file if it does not exist.
Parameters:
| Name | Type | Description |
|---|---|---|
filePath | โ | โ |
text | โ | โ |
AppendTextArrayToFile
def AppendTextArrayToFile(filePath, block)Open a text file, append the given text array and close it. Create a new file if it does not exist.
Parameters:
| Name | Type | Description |
|---|---|---|
filePath | โ | โ |
block | โ | โ |
Version Notes
This class is documented as of release R2026.1.1.