fix: Fixed the stubs generator

[Masara]

Closes #80

Summary of Changes

Fixed the stub generator, it should now run with the Library project.

To run the script, use the following command:
safe-ds-stubgen -p "Library" -o "path/to/out" -nc -s "path/to/Library/src" --docstyle NUMPYDOC

[Masara]

@lars-reimann The src.safeds.data.tabular.containers._column.Column.all, src.safeds.data.tabular.containers._column.Column.any and src.safeds.data.tabular.containers._column.Column.none methods have Callable[[T], bool]) as type for the predicate parameter. The type is written wrong b/c of the ) at the end of the type.

[github-actions]

🦙 MegaLinter status: ✅ SUCCESS

Descriptor	Linter	Files	Fixed	Errors	Elapsed time
✅ MARKDOWN	markdown-link-check	1		0	1.82s
✅ PYTHON	black	14	0	0	1.54s
✅ PYTHON	mypy	14		0	6.42s
✅ PYTHON	ruff	14	0	0	0.05s
✅ REPOSITORY	git_diff	yes		no	0.03s

See detailed report in MegaLinter reports
Set VALIDATE_ALL_CODEBASE: true in mega-linter.yml to validate all sources, not only the diff

MegaLinter is graciously provided by

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.53%. Comparing base (6665186) to head (e610cd4).

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #108      +/-   ##
==========================================
+ Coverage   99.30%   99.53%   +0.22%     
==========================================
  Files          22       22              
  Lines        2291     2341      +50     
==========================================
+ Hits         2275     2330      +55     
+ Misses         16       11       -5     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[lars-reimann]

Feel free to report that in the library repo.

[Masara]

Could you merge this next? I need the fixes here for the remaining issue.

[lars-reimann]

I'm still getting this error for Safe-DS/Library@e01ad89:

Traceback (most recent call last):
  File "C:\Users\Lars\AppData\Local\pypoetry\Cache\virtualenvs\safe-ds-stubgen-VELKLkPa-py3.12\Scripts\\safe-ds-stubgen", line 6, in <module>
    sys.exit(main())
             ^^^^^^
  File "E:\Repositories\safe-ds\Stub-Generator\src\safeds_stubgen\main.py", line 14, in main
    cli()
  File "E:\Repositories\safe-ds\Stub-Generator\src\safeds_stubgen\api_analyzer\cli\_cli.py", line 20, in cli
    _run_api_command(args.package, args.src, args.out, args.docstyle, args.testrun, args.naming_convert)
  File "E:\Repositories\safe-ds\Stub-Generator\src\safeds_stubgen\api_analyzer\cli\_cli.py", line 96, in _run_api_command
    api = get_api(package, src_dir_path, docstring_style, is_test_run)
          ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "E:\Repositories\safe-ds\Stub-Generator\src\safeds_stubgen\api_analyzer\_get_api.py", line 72, in get_api
    walker.walk(tree=tree)
  File "E:\Repositories\safe-ds\Stub-Generator\src\safeds_stubgen\api_analyzer\_ast_walker.py", line 30, in walk
    self.__walk(tree, set())
  File "E:\Repositories\safe-ds\Stub-Generator\src\safeds_stubgen\api_analyzer\_ast_walker.py", line 68, in __walk
    self.__walk(child_node, visited_nodes)
  File "E:\Repositories\safe-ds\Stub-Generator\src\safeds_stubgen\api_analyzer\_ast_walker.py", line 42, in __walk
    self.__enter(node)
  File "E:\Repositories\safe-ds\Stub-Generator\src\safeds_stubgen\api_analyzer\_ast_walker.py", line 74, in __enter
    method(node)
  File "E:\Repositories\safe-ds\Stub-Generator\src\safeds_stubgen\api_analyzer\_ast_visitor.py", line 264, in enter_funcdef
    results = self._parse_results(node, function_id, result_docstrings)
              ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "E:\Repositories\safe-ds\Stub-Generator\src\safeds_stubgen\api_analyzer\_ast_visitor.py", line 446, in _parse_results
    ret_type = self.mypy_type_to_abstract_type(node_ret_type, unanalyzed_ret_type)
               ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "E:\Repositories\safe-ds\Stub-Generator\src\safeds_stubgen\api_analyzer\_ast_visitor.py", line 1004, in mypy_type_to_abstract_type
    raise ValueError("Unexpected type.")  # pragma: no cover
    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
ValueError: Unexpected type.

[Masara]

@lars-reimann I removed the raises like you said and instead added the unknown type. I also removed the -p (package name) argument, since we don't really need it. Could you check again if it works for you?

[Masara]

@lars-reimann Could you also check the linter error?

❌ Linted [MARKDOWN] files with [markdown-link-check]: Found 1 error(s) - (3.07s) (expand for details)
  - Using [markdown-link-check v3.11.2] https://megalinter.io/7.10.0/descriptors/markdown_markdown_link_check
  - MegaLinter key: [MARKDOWN_MARKDOWN_LINK_CHECK]
  - Rules config: [/github/workspace/.github/linters/.markdown-link-check.json]
  - Number of files analyzed: [1]
  --Error detail:
  (node:56) [DEP0040] DeprecationWarning: The `punycode` module is deprecated. Please use a userland alternative instead.
  (Use `node --trace-deprecation ...` to show where the warning was created)
  
    ERROR: 1 dead links found in docs/README.md !
    [✖] https://dsl.safeds.com/en/stable/language/stub-language/ → Status: 404

[lars-reimann]

@Masara You can replace the link with https://dsl.safeds.com/en/stable/stub-language/.

[Masara]

I added a # pragma: no cover for the function safeds_stubgen.api_analyzer._get_api._get_nearest_init_dirs since I don't know how to test it. The glob searches every file and is usually sorted the way we want, but we have to make sure anyway if it's the file we need, since we can't be 100% sure that glob always does what we want. But I can't write tests for test coverage, since the glob sorts the files for us.

[lars-reimann]

Works beautifully now, thank you.

[lars-reimann]

🎉 This PR is included in version 0.3.0 🎉

The release is available on:

• v0.3.0
• GitHub release

Your semantic-release bot 📦🚀