NameScrambleFilter

class ipkiss3.all.NameScrambleFilter

Filter for scrambling a Structure’s name.

Parameters:

max_name_length: ( int and number > 0 ), optional, *None allowed*

Maximum name length before it is scrambled

scramble_all: ( bool, bool_ or int ), optional

Scramble all names (True), or just the names which are too long (False)?

default_replacement: ( str and String that contains only ISO/IEC 8859-1 (extended ASCII py3) or pure ASCII (py2) characters ), optional

default character (or function) for characters that are not allowed

replace_characters: optional

dictionary with characters to be replaced

allowed_characters: ( str and String that contains only ISO/IEC 8859-1 (extended ASCII py3) or pure ASCII (py2) characters ), optional, *None allowed*

characters that are allowed in the name

name: ( str and String that contains only ISO/IEC 8859-1 (extended ASCII py3) or pure ASCII (py2) characters ), optional, *None allowed*