# initialize the array object class.
array = Array(
    # the array (param #1).
    array=[],
    # the path (param #2).
    path=False,
    # load the data on initialization.
    load=False,
    # the default array (will be created if file path does not exist).
    default=None, )

# call array.save.
_ = array.save(array=None, path=None, ensure_ascii=False, indent=4, sudo=False)

# call array.load.
_ = array.load(default=None)

# call array.string.
_ = array.string(joiner=" ", sum_first=False)

# call array.divide.
_ = array.divide(into=2)

# call array.remove.
_ = array.remove(indexes=[], values=[], update=True, save=False)

# call array.append.
_ = array.append(var)

# call array.pop.
_ = array.pop(index)

# call array.count.
_ = array.count(item=None)

# call array.check.
_ = array.check(default=None, save=True)

# call array.clean.
_ = array.clean(
    # the string replacements.
    #    example:
    #        { "Hello":"hello" }
    #        [ ["Hello", "hello"] ]
    replacements={},
    # the first characters to remove (String & Array).
    remove_first=[],
    # the last characters to remove (String & Array).
    remove_last=[],
    # the first characters that are ensured (String & Array) (List: check is one of the list is ensured).
    ensure_first=[],
    # the last characters that are ensured (String & Array) (List: check is one of the list is ensured).
    ensure_last=[],
    # remove all values within the list from the array.
    remove_values=[],
    # update the self array.
    update=True,
    # the dicionary (leave None to use array.array).
    array=None, )

# call array.iterate.
_ = array.iterate(sorted=False, reversed=False, array=None)

# call array.items.
_ = array.items(sorted=False, reversed=False, array=None)

# call array.keys.
_ = array.keys(sorted=False, reversed=False, array=None)

# call array.reversed.
_ = array.reversed(array=None)

# call array.sort.
_ = array.sort(alphabetical=True, ascending=False, reversed=False, array=None)

# call array.json.
_ = array.json(sorted=False, reversed=False, indent=4, array=None, )

# call array.serialize.
_ = array.serialize(sorted=False, reversed=False, json=False, array=None)

# call array.instance.
_ = array.instance()

# call array.assign.
_ = array.assign(array, save=False)

# initialize the boolean object class.
boolean = Boolean(boolean=False)

# call boolean.convert.
_ = boolean.convert(true="True", false="False")

# call boolean.instance.
_ = boolean.instance()

# call boolean.assign.
_ = boolean.assign(boolean)

# initialize the bytes object class.
bytes = Bytes(
    # the bytes (param #1).
    data=b"",
    # the file path.
    path=None, )

# call bytes.load.
_ = bytes.load()

# call bytes.save.
_ = bytes.save(bytes=None, sudo=False)

# call bytes.instance.
_ = bytes.instance()

# call bytes.assign.
_ = bytes.assign(b)

# initialize the date object class.
date = Date()

# call date.compare.
_ = date.compare(comparison=None, current=None, format="%d-%m-%y %H:%M")

# call date.increase.
_ = date.increase(string, weeks=0, days=0, hours=0, minutes=0, seconds=0, format="%d-%m-%y %H:%M")

# call date.decrease.
_ = date.decrease(string, weeks=0, days=0, hours=0, minutes=0, seconds=0, format="%d-%m-%y %H:%M")

# call date.to_seconds.
_ = date.to_seconds(string, format="%d-%m-%y %H:%M")

# call date.from_seconds.
_ = date.from_seconds(seconds, format="%d-%m-%y %H:%M")

# call date.convert.
_ = date.convert(string, input="%d-%m-%y %H:%M", output="%Y%m%d")

# call date.instance.
_ = date.instance()

# initialize the dictionary object class.
dictionary = Dictionary(
    # the dictionary (param #1).
    dictionary={},
    # the file path (param #2).
    path=False,
    # load the file path dictionary on init.
    load=False,
    # specify default to check & create the dict.
    default=None, )

# call dictionary.save.
_ = dictionary.save(dictionary=None, path=None, ensure_ascii=False, indent=4, sudo=False)

# call dictionary.load.
_ = dictionary.load(default=None)

# call dictionary.load_line.
_ = dictionary.load_line(line_number)

# call dictionary.check.
_ = dictionary.check(
    #   Option 1:
    key=None, # check a certain key, it appends if not present
    value=None, # check a certain key, append the value if not present (no format check)
    #   Option 2:
    default=None, # check based on a default dictionary, it appends it not present.
    #   Optionals:
    dictionary=None, # overwrite the start dictionary, leave None to use dictionary.dictionary.
    save=False, # saves the output & and sets the output to dictionary.dictionary.
    def __iterate_dict__(dictionary, default):
        #print("\niterating new dictionary: [{}] & default [{}]\n".format(dictionary, default))
        for identifier, item in default.items():
            if isinstance(item, dict):
                try: dictionary[identifier] = __iterate_dict__(dictionary[identifier], item)
                except KeyError: dictionary[identifier] = dict(item)
            elif isinstance(item, list):
                try: dictionary[identifier]
                except KeyError: dictionary[identifier] = list(item)
            else:
                try: dictionary[identifier]
                except KeyError: dictionary[identifier] = item
        return dictionary
    # init.
    if dictionary == None: dictionary = dictionary.dictionary
    #   -   option 1:
    if key == None and value != None: raise ValueError("Define both parameters: [key & value].")
    elif value == None and key != None: raise ValueError("Define both parameters: [key & value].")
    if key != None and value != None:
        try: dictionary[key]
        except KeyError: dictionary[key] = value
        return dictionary
    #   -   option 2:
    if default == None: default = dictionary.default
    if default == None: raise ValueError("Define both parameters: [key & value] or parameter [default].")
    dictionary = __iterate_dict__(dictionary, default)
    if save:
        dictionary.dictionary = dictionary
        dictionary.save()
    return dictionary

# call dictionary.divide.
_ = dictionary.divide(into=2)

# call dictionary.append.
_ = dictionary.append(
    # by default it only overwrites if a key does not exist and sums the key if it is a str / int.
    #
    # a dictionary to append.
    dictionary,
    # the overwrite formats (add "*" for all).
    overwrite=[],
    # the sum formats (add "*" for all).
    sum=["int", "float"],
    # the banned dictionary keys.
    banned=[],
    # update the self dict.
    update=True,
    # save the new dict.
    save=False,
    # do not use.
    dictionary_=None, )

# call dictionary.unpack.
_ = dictionary.unpack(
    # the key / keys / defaults parameter (#1).
    # str instance:
    #   unpack the str key
    # list instance:
    #   unpack all keys in the list.
    # dict instance:
    #   unpack all keys from the dict & when not present return the key's value as default.
    keys, )

# call dictionary.remove.
_ = dictionary.remove(keys=[], values=[], update=True, save=False, dictionary=None)

# call dictionary.count.
_ = dictionary.count(item=None, values=False)

# call dictionary.iterate.
_ = dictionary.iterate(sorted=False, reversed=False, dictionary=None)

# call dictionary.items.
_ = dictionary.items(sorted=False, reversed=False, dictionary=None)

# call dictionary.keys.
_ = dictionary.keys(sorted=False, reversed=False, dictionary=None)

# call dictionary.values.
_ = dictionary.values(sorted=False, reversed=False, dictionary=None)

# call dictionary.reversed.
_ = dictionary.reversed(update=True, dictionary=None)

# call dictionary.sort.
_ = dictionary.sort(alphabetical=True, ascending=False, reversed=False, update=True, dictionary=None)

# call dictionary.json.
_ = dictionary.json(sorted=False, reversed=False, indent=4, dictionary=None, )

# call dictionary.serialize.
_ = dictionary.serialize(sorted=False, reversed=False, json=False, dictionary=None)

# call dictionary.instance.
_ = dictionary.instance(serialize=False)

# call dictionary.assign.
_ = dictionary.assign(dictionary, save=False)

# initialize the directory object class.
directory = Directory(
    # the dirs file path (param #1).
    path=None,
    # the hierarchy to check / create.
    hierarchy={},
    # load the content.
    #load=False,
    # load recursive.
    #recursive=False, )

# call directory.create.
_ = directory.create(file_paths=[], path=None, sudo=False, owner=None, group=None, permission=None)

# call directory.delete.
_ = directory.delete(forced=False)

# call directory.check.
_ = directory.check(
    #   Required:
    #   -   dictionary format:
    hierarchy=None,
    #   Optionals:
    #   -   string format:
    owner=None,
    group=None,
    #   -   boolean format:
    sudo=False,
    #   -   integer format:
    permission=None, # (octal format)
    recursive=False, # for permission/ownership
    silent=False, )

# call directory.paths.
_ = directory.paths(dirs_only=False, files_only=False, empty_dirs=True, recursive=False, path=None, banned=[], banned_names=[".DS_Store"], banned_basenames=["__pycache__"], extensions=["*"])

# call directory.names.
_ = directory.names(dirs_only=False, files_only=False, empty_dirs=True, recursive=False, path=None, banned=[], banned_names=[".DS_Store"], extensions=["*"], remove_extensions=False)

# call directory.oldest_path.
_ = directory.oldest_path()

# call directory.random_path.
_ = directory.random_path()

# call directory.generate_path.
_ = directory.generate_path(length=24, type="/")

# call directory.structured_join.
_ = directory.structured_join(name, type="", structure="alphabetical", create_base=False, sudo=False, owner=None, group=None, permission=None)

# call directory.join.
_ = directory.join(name=None, type="")

# call directory.contains.
_ = directory.contains(name=None, type="/", recursive=False)

# call directory.subpath.
_ = directory.subpath(fullpath)

# call directory.fullpath.
_ = directory.fullpath(subpath)

# call directory.index.
_ = directory.index(
    # the wanted options.
    metrics=[],
    options=["size", "mtime", "content", "name", "basename", "extension", "mount", "directory"],
    # optional path (leave None to use directory.path).
    path=None, )

# call directory.find.
_ = directory.find(matches:list, path=None, recursive=False, log_level=0)

# call directory.replace.
_ = directory.replace(replacements:list, path=None, recursive=False, log_level=0)

# call directory.instance.
_ = directory.instance()

# initialize the file object class.
file = File(path=None, data=None, load=False, default=None)

# call file.load.
_ = file.load(default=None)

# call file.load_line.
_ = file.load_line(line_number, default=None)

# call file.save.
_ = file.save(data=None, path=None, overwrite_duplicates=True, sudo=False)

# call file.check.
_ = file.check(default=None, save=True)

# call file.instance.
_ = file.instance()

# call file.assign.
_ = file.assign(data)

# initialize the file_path object class.
file_path = FilePath(path, default=False, check=False, load=False)

# call file_path.join.
_ = file_path.join(name=None, type="/")

# call file_path.name.
_ = file_path.name(remove_extension=False, path=None)

# call file_path.extension.
_ = file_path.extension(name=None, path=None)

# call file_path.base.
_ = file_path.base(
    # the path (leave None to use file_path.path) (param #1).
    path=None,
    # the dirs back.
    back=1, )

# call file_path.basename.
_ = file_path.basename(back=1, path=None)

# call file_path.size.
_ = file_path.size(mode="auto", options=["auto", "bytes", "kb", "mb", "gb", "tb"], format=str, path=None)

# call file_path.exists.
_ = file_path.exists(
    # the path (leave None to use file_path.path) (#1).
    path=None,
    # root permission required.
    sudo=False, )

# call file_path.mount.
_ = file_path.mount(
    # the path (leave None to use file_path.path) (#1).
    path=None, )

# call file_path.directory.
_ = file_path.directory(
    # the path (leave None to use file_path.path) (#1).
    path=None, )

# call file_path.mtime.
_ = file_path.mtime(format='%d-%m-%y %H:%M.%S', path=None)

# call file_path.clean.
_ = file_path.clean(
    # the path (leave None to use file_path.path) (param #1).
    path=None,
    # the clean options.
    remove_double_slash=True,
    remove_first_slash=False,
    remove_last_slash=False,
    ensure_first_slash=False,
    ensure_last_slash=False, )

# call file_path.absolute.
_ = file_path.absolute(
    # the path (leave None to use file_path.path) (param #1).
    path=None, )

# call file_path.module.
_ = file_path.module(path=None)

# call file_path.requirements.
_ = file_path.requirements(path=None, format="pip", include_version=True)

# call file_path.delete.
_ = file_path.delete(
    # the path (leave None to use file_path.path) (param #1).
    path=None,
    # the options.
    forced=False,
    sudo=False,
    silent=False, )

# call file_path.move.
_ = file_path.move(path=None, sudo=False, silent=False)

# call file_path.copy.
_ = file_path.copy(path=None, sudo=False, silent=False)

# call file_path.open.
_ = file_path.open(sudo=False)

# call file_path.create.
_ = file_path.create(
    #   Option 1: (creating a directory)
    #   -   boolean format:
    directory=False,
    #   Option 2: (creating any file extension)
    #   -   string format:
    data="",
    #   Options:
    #   -   integer format:
    permission=None,
    #   -   string format:
    owner=None,
    group=None,
    #   -   boolean format:
    sudo=False, )

# call file_path.check.
_ = file_path.check(
    #   Option 1: (creating a directory)
    #   -   boolean format:
    directory=False,
    #   Option 2: (creating any file extension)
    #   -   string format:
    data="",
    #   Options:
    #   -   integer format:
    permission=None,
    #   -   string format:
    owner=None,
    group=None,
    #   -   boolean format:
    sudo=False,
    silent=False,
    recursive=False, # for directories only (for permission & ownership check) )

# call file_path.split.
_ = file_path.split(path)

# call file_path.count.
_ = file_path.count(path)

# call file_path.replace.
_ = file_path.replace(from_, to_)

# call file_path.lower.
_ = file_path.lower(path)

# call file_path.upper.
_ = file_path.upper(path)

# call file_path.instance.
_ = file_path.instance()

# call file_path.assign.
_ = file_path.assign(path, load=False)

# initialize the files object class.
files = Files(path=None, name=None, type="")

# call files.join.
_ = files.join(path=None, name=None, type="")

# call files.load.
_ = files.load(path, data="not to be used", format="str", raw=False)

# call files.save.
_ = files.save(path, data, format="str", sudo=False, indent=4, ensure_ascii=False)

# call files.delete.
_ = files.delete(
    # the path (param #1).
    path=None,
    # root permission required.
    sudo=False,
    # forced mode.
    forced=False,
    # hide logs.
    silent=False, )

# call files.chmod.
_ = files.chmod(
    # the path (param #1).
    path=None,
    # the new permission.
    permission=None,
    # recursive for entire dir.
    recursive=False,
    # root permission required.
    sudo=False, )

# call files.chown.
_ = files.chown(
    # the path (param #1).
    path=None,
    # the new owner.
    owner=None,
    # the new group (optional).
    group=None,
    # recursive for entire dir.
    recursive=False,
    # root permission required.
    sudo=False, )

# call files.exists.
_ = files.exists(path=None, sudo=False)

# call files.directory.
_ = files.directory(
    # the path (leave None to use files.path) (#1).
    path=None, )

# initialize the formats object class.
formats = Formats(i.upper())

# call formats.check.
_ = formats.check(
    nones=None,
    booleans=None,
    none_allowed_booleans=None,
    strings=None,
    none_allowed_strings=None,
    integers=None,
    none_allowed_integers=None,
    bytes_=None,
    none_allowed_bytes=None,
    arrays=None,
    none_allowed_arrays=None,
    dictionaries=None,
    none_allowed_dictionaries=None, )

# call formats.get.
_ = formats.get(value, serialize=False)

# call formats.initialize.
_ = formats.initialize(
    # the object / value (#1 param).
    obj=None,
    # list / dict with objects.
    objects=None,
    # initialize file paths.
    file_paths=False,
    # the forced format.
    format=None, )

# call formats.denitialize.
_ = formats.denitialize(
    # the object / value (#1 param).
    obj=None,
    # list / dict with objects.
    objects=None,
    # initialize file paths.
    file_paths=True, )

# initialize the image object class.
image = Image(path=None, image=None, load=False)

# call image.load.
_ = image.load(path=None)

# call image.edit_pixel.
_ = image.edit_pixel(pixel=[0, 0], new_pixel_tuple=None)

# call image.instance.
_ = image.instance()

# initialize the integer object class.
integer = Integer(value=0, format="auto")

# call integer.increase_version.
_ = integer.increase_version()

# call integer.round.
_ = integer.round(decimals)

# call integer.round_down.
_ = integer.round_down(decimals)

# call integer.generate.
_ = integer.generate(length=6)

# call integer.instance.
_ = integer.instance()

# call integer.assign.
_ = integer.assign(value)

# initialize the ownership object class.
ownership = Ownership(path=None, load=False)

# call ownership.get.
_ = ownership.get(path=None)

# call ownership.set.
_ = ownership.set(owner=None, group=None, sudo=False, recursive=False, silent=False, path=None)

# call ownership.check.
_ = ownership.check(owner=None, group=None, sudo=False, silent=False, iterate=False, recursive=False, path=None)

# initialize the permission object class.
permission = Permission(path=None, load=False)

# call permission.get.
_ = permission.get(path=None)

# call permission.set.
_ = permission.set(permission=None, sudo=False, recursive=False, silent=False, path=None)

# call permission.check.
_ = permission.check(permission=None, sudo=False, silent=False, iterate=False, recursive=False, path=None)

# initialize the string object class.
string = String(string="")

# call string.is_numerical.
_ = string.is_numerical()

# call string.bash.
_ = string.bash()

# call string.identifier.
_ = string.identifier()

# call string.variable_format.
_ = string.variable_format(
    exceptions={
        "smart_card":"smartcard",
        "smart_cards":"smartcards" ,
    }, )

# call string.class_format.
_ = string.class_format()

# call string.capitalized_scentence.
_ = string.capitalized_scentence()

# call string.capitalized_word.
_ = string.capitalized_word()

# call string.generate.
_ = string.generate(
    # the length of the generated string.
    length=6,
    # include digits.
    digits=False,
    # include capital letters.
    capitalize=False,
    # include special characters.
    special=False, )

# call string.first_occurence.
_ = string.first_occurence(charset=[" ", "\n"], reversed=False, string=None)

# call string.before_after_first_occurence.
_ = string.before_after_first_occurence(slicer=" ", include=True, include_before=False, include_after=False, string=None)

# call string.before_selected_after_first_occurence.
_ = string.before_selected_after_first_occurence(slicer=" ", string=None)

# call string.before_after_last_occurence.
_ = string.before_after_last_occurence(slicer=" ", include=True, include_before=False, include_after=False, string=None)

# call string.before_selected_after_last_occurence.
_ = string.before_selected_after_last_occurence(slicer=" ", string=None)

# call string.between.
_ = string.between(identifiers=["{","}"], depth=1, include=True, string=None)

# call string.increase_version.
_ = string.increase_version()

# call string.slice_dict.
_ = string.slice_dict(depth=1)

# call string.slice_array.
_ = string.slice_array(depth=1)

# call string.slice_tuple.
_ = string.slice_tuple(depth=1)

# call string.indent.
_ = string.indent(indent=4)

# call string.line_indent.
_ = string.line_indent(line="")

# call string.slice_indent.
_ = string.slice_indent(indent=4, depth=1, string=None, remove_indent=True)

# call string.split.
_ = string.split(string)

# call string.count.
_ = string.count(string)

# call string.replace.
_ = string.replace(from_, to_)

# call string.lower.
_ = string.lower(string)

# call string.upper.
_ = string.upper(string)

# call string.instance.
_ = string.instance()

# call string.assign.
_ = string.assign(string)

# initialize the zip object class.
zip = Zip(path=None, check=False)

# call zip.create.
_ = zip.create(
    # source can either be a string or an array.
    source=None,
    # remove the source file(s).
    remove=False,
    # sudo required to move/copy source files.
    sudo=False, )

# call zip.extract.
_ = zip.extract(
    # the base extract directory.
    base=None,
    # remove the zip after extraction.
    remove=False,
    # if sudo required for removing file path.
    sudo=False,)

# call zip.instance.
_ = zip.instance()