lotecc package

lotecc.cli module

Console script for lotecc, to convert files between Simplified Chinese and Traditional Chinese

lotecc.lotecc module

class lotecc.lotecc.LoteccConfig[source]

Bases: pydantic.main.BaseModel

ignore_patterns

Read ignore patterns from file, or get from input string.

Returns:list, the .gitignore syntax patterns.
input_files
List files filtered by ignore patterns in the input directory,

or a input file.

return:list, the files to convert.
classmethod valid_conversion(v: str) → str[source]

Validate argument of conversion.

Parameters:v – str, the value of conversion.
Returns:str, the valid value of conversion.
Raise:raise a ValueError if conversion is not supported.
lotecc.lotecc.check_file_exist(filename: str) → str[source]

Check if the file exists in the current directory or the upper directories.

Parameters:filename – str, the filename.
Returns:str, a abspath of the file if exist, else a empty string.
lotecc.lotecc.get_list_of_files(dir_name: str, ignores: list) → list[source]

Get all files in a directory excluding ignored files.

Parameters:
  • dir_name – str, the root directory.
  • ignores – str, the patterns to exclude.
Returns:

list, the files excluding ignored files.
lotecc.lotecc.lote_chinese_conversion(**kwargs)[source]

Convert files between Simplified Chinese and Traditional Chinese.

Parameters:
  • conversion – str, default ‘s2t’, the conversion method.
  • input – str, default ‘.’, an input file or a directory.
  • output – str, default None, an output file or a directory.
  • in_enc – str, default ‘utf-8’, encoding for input.
  • out_enc – str, default ‘utf-8’, encoding for output.
  • suffix – str, default None, suffix of output filename.
  • ignore – str, default ‘.gitignore’, a .gitignore syntax file, or patterns, separated by commas.
Returns:

list, list of tuples, a tuple contains source file and converted file.
lotecc.lotecc.read_ignores(ignore_file: str) → list[source]

Read ignore patterns from a .gitignore syntax file.

Parameters:ignore_file – str, the ignore file, may not be the correct path.
Returns:list, the ignore patterns.

Module contents

Top-level package for lotecc.

lotecc.lote_chinese_conversion(**kwargs)[source]

Convert files between Simplified Chinese and Traditional Chinese.

Parameters:
  • conversion – str, default ‘s2t’, the conversion method.
  • input – str, default ‘.’, an input file or a directory.
  • output – str, default None, an output file or a directory.
  • in_enc – str, default ‘utf-8’, encoding for input.
  • out_enc – str, default ‘utf-8’, encoding for output.
  • suffix – str, default None, suffix of output filename.
  • ignore – str, default ‘.gitignore’, a .gitignore syntax file, or patterns, separated by commas.
Returns:

list, list of tuples, a tuple contains source file and converted file.