:py:mod:`file_manager`
======================

.. py:module:: file_manager


Module Contents
---------------

Classes
~~~~~~~

.. autoapisummary::

   file_manager.Type



Functions
~~~~~~~~~

.. autoapisummary::

   file_manager.get_path_type_str
   file_manager.path
   file_manager.folder_path



Attributes
~~~~~~~~~~

.. autoapisummary::

   file_manager.logger


.. py:data:: logger
   :value: "'file_manager'"

   

.. py:class:: Type(*args, **kwds)


   Bases: :py:obj:`enum.Enum`

   Create a collection of name/value pairs.

   Example enumeration:

   >>> class Color(Enum):
   ...     RED = 1
   ...     BLUE = 2
   ...     GREEN = 3

   Access them by:

   - attribute access::

   >>> Color.RED
   <Color.RED: 1>

   - value lookup:

   >>> Color(1)
   <Color.RED: 1>

   - name lookup:

   >>> Color['RED']
   <Color.RED: 1>

   Enumerations can be iterated over, and know how many members they have:

   >>> len(Color)
   3

   >>> list(Color)
   [<Color.RED: 1>, <Color.BLUE: 2>, <Color.GREEN: 3>]

   Methods can be added to enumerations, and members can have their own
   attributes -- see the documentation for details.

   .. py:attribute:: ProjectRoot

      

   .. py:attribute:: ResourcesRoot

      

   .. py:attribute:: Source

      

   .. py:attribute:: UI

      

   .. py:attribute:: Icons

      

   .. py:attribute:: Docs

      

   .. py:attribute:: Data

      


.. py:function:: get_path_type_str(path_enum: Type)


.. py:function:: path(name: str, file_type: Type = None, custom_folder: str = None)

   Get absolute path to resource, works for dev and for PyInstaller


.. py:function:: folder_path(folder_name: str = None, resource_type: Type = None)