Merge pull request #23 from MichaelisTrofficus/bump-to-0.0.5

Bump to 0.0.5

Author: MichaelisTrofficus

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "gpt4docstrings"
-version = "0.0.4"
+version = "0.0.5"
 description = "gpt4docstrings"
 authors = ["Miguel Otero Pedrido <miguel.otero.pedrido.1993@gmail.com>"]
 license = "MIT"
@@ -9,7 +9,7 @@ homepage = "https://github.com/MichaelisTrofficus/gpt4docstrings"
 repository = "https://github.com/MichaelisTrofficus/gpt4docstrings"
 documentation = "https://gpt4docstrings.readthedocs.io"
 classifiers = [
-    "Development Status :: 1 - Planning",
+    "Development Status :: 3 - Alpha",
 ]
 
 [tool.poetry.urls]

src/gpt4docstrings/cli.py

@@ -58,4 +58,5 @@ def main(paths, **kwargs):
         model=kwargs["model"],
         api_key=kwargs["api_key"],
     )
-    docstrings_generator.generate_docstrings()
+    filenames = docstrings_generator.generate_docstrings()
+    print(filenames)

src/gpt4docstrings/generate_docstrings.py

@@ -62,7 +62,10 @@ def get_filenames_from_paths(self) -> List[str]:
             if os.path.isfile(path):
                 if not path.endswith(".py"):
                     return sys.exit(1)
-                filenames.append(path)
+
+                if not any(fnmatch(path, exc + "*") for exc in self.excluded):
+                    filenames.append(path)
+
                 continue
 
             for root, _, fs in os.walk(path):
@@ -126,3 +129,4 @@ def generate_docstrings(self):
         """Generates docstrings for undocumented classes / functions"""
         filenames = self.get_filenames_from_paths()
         self._generate_docstrings(filenames)
+        return filenames

tests/test_find_filenames.py

@@ -19,7 +19,7 @@ def test_find_all_functions(test_openai_api_key):
 def test_exclude_functions(test_openai_api_key):
     docstrings_generator = GPT4Docstrings(
         paths=[os.path.join(pytest.TESTS_PATH, "resources")],
-        excluded=[os.path.join(pytest.TESTS_PATH, "resources/package_1/*")],
+        excluded=[os.path.join(pytest.TESTS_PATH, "resources/package_1/module_2.py")],
     )
     py_files = docstrings_generator.get_filenames_from_paths()
     assert set(py_files) == {f"{pytest.TESTS_PATH}/resources/module_1.py"}