nmk_proto.files
===============

.. py:module:: nmk_proto.files

.. autoapi-nested-parse::

   File resolvers sub-module



Classes
-------

.. autoapisummary::

   nmk_proto.files.ProtoFilesFinder
   nmk_proto.files.ProtoAllSubDirsFinder
   nmk_proto.files.ProtoUniqueSubDirsFinder
   nmk_proto.files.ProtoPathOptionsBuilder


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

.. py:class:: ProtoFilesFinder(model: nmk.model.model.NmkModel)

   Bases: :py:obj:`nmk.model.resolver.NmkListConfigResolver`


   Input proto files resolver


   .. py:method:: get_value(name: str) -> List[pathlib.Path]

      List all proto files found in input folder

      :param name: config item name
      :return: list of input proto files



.. py:class:: ProtoAllSubDirsFinder(model: nmk.model.model.NmkModel)

   Bases: :py:obj:`nmk.model.resolver.NmkListConfigResolver`


   Proto subfolders list resolver


   .. py:method:: get_value(name: str) -> List[pathlib.Path]

      List all proto sub-folders (one per file)

      :param name: config item name
      :return: list of proto sub-folders



.. py:class:: ProtoUniqueSubDirsFinder(model: nmk.model.model.NmkModel)

   Bases: :py:obj:`nmk.model.resolver.NmkListConfigResolver`


   Proto subfolders set resolver


   .. py:method:: get_value(name: str) -> List[pathlib.Path]

      List all proto sub-folders (no duplicates)

      :param name: config item name
      :return: set of proto sub-folders



.. py:class:: ProtoPathOptionsBuilder(model: nmk.model.model.NmkModel)

   Bases: :py:obj:`nmk.model.resolver.NmkListConfigResolver`


   Paths options list resolver


   .. py:method:: get_value(name: str) -> List[str]

      Build path options list for protoc command

      :param name: config item name
      :return: list of path options