timor.utilities.file_locations
==============================

.. py:module:: timor.utilities.file_locations


Attributes
----------

.. autoapisummary::

   timor.utilities.file_locations.DEFAULT_TASK_FILTER
   timor.utilities.file_locations.__utilities
   timor.utilities.file_locations.cache_dir
   timor.utilities.file_locations.cache_robot_dir
   timor.utilities.file_locations.default_robot_dir
   timor.utilities.file_locations.head
   timor.utilities.file_locations.module_DBs
   timor.utilities.file_locations.package
   timor.utilities.file_locations.robots
   timor.utilities.file_locations.schema_dir
   timor.utilities.file_locations.schemata
   timor.utilities.file_locations.test_data
   timor.utilities.file_locations.test_data


Functions
---------

.. autoapisummary::

   timor.utilities.file_locations.clean_caches
   timor.utilities.file_locations.get_module_db_files
   timor.utilities.file_locations.get_test_tasks
   timor.utilities.file_locations.map2path


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

.. py:data:: DEFAULT_TASK_FILTER

.. py:data:: __utilities

.. py:data:: cache_dir

.. py:data:: cache_robot_dir

.. py:function:: clean_caches()

   Helper to clean timor caches, e.g., to download all module sets after they have been updated.


.. py:data:: default_robot_dir

.. py:function:: get_module_db_files(name)

   Returns the filepaths to the database json file and the package folder for names of valid module databases.

   :param name: The (folder) name of the module set
   :return: Path to modules.json (all assets are in the same folder)


.. py:function:: get_test_tasks(task_name = DEFAULT_TASK_FILTER)

   Gives access to all test tasks from the test_data folder.

   :param task_name: A regular expression pattern that is run against task files to be loaded
   :return: A dictionary mapping the "kind" of the task or solution file to the matching path.


.. py:data:: head

.. py:function:: map2path(p)

   Maps strings to paths, but does nothing else s.t. e.g. Django paths are not casted.


.. py:data:: module_DBs

.. py:data:: package

.. py:data:: robots

.. py:data:: schema_dir

.. py:data:: schemata

.. py:data:: test_data

.. py:data:: test_data
   :value: None