Use ansys-tools-path package #1995

germa89 · 2023-04-17T04:27:41Z

As the title.

Notes:

I have intentionally left some functions to check the API of that package.

codecov · 2023-04-17T06:52:57Z

Codecov Report

Merging #1995 (1e12778) into main (a25fa9e) will decrease coverage by 0.09%.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##             main    #1995      +/-   ##
==========================================
- Coverage   82.98%   82.89%   -0.09%     
==========================================
  Files          44       44              
  Lines        7932     7850      -82     
==========================================
- Hits         6582     6507      -75     
+ Misses       1350     1343       -7

clatapie

LGTM!

for more information, see https://pre-commit.ci

germa89 · 2023-04-18T04:22:28Z

I'm having some issues with injecting documentation in docstring. It does not make sense. Only #1991 #1996 has been implemented, and I dont see why these should change anything...

Error:

/opt/hostedtoolcache/Python/3.9.16/x64/lib/python3.9/site-packages/ansys/mapdl/core/_commands/solution/fe_constraints.py:docstring of ansys.mapdl.core._commands.solution.fe_constraints.FeConstraints.dlist:26: ERROR: Unexpected indentation.
/opt/hostedtoolcache/Python/3.9.16/x64/lib/python3.9/site-packages/ansys/mapdl/core/_commands/solution/fe_constraints.py:docstring of ansys.mapdl.core._commands.solution.fe_constraints.FeConstraints.dlist:23: WARNING: Block quote ends without a blank line; unexpected unindent.
/opt/hostedtoolcache/Python/3.9.16/x64/lib/python3.9/site-packages/ansys/mapdl/core/_commands/solution/fe_forces.py:docstring of ansys.mapdl.core._commands.solution.fe_forces.FeForces.flist:25: ERROR: Unexpected indentation.
/opt/hostedtoolcache/Python/3.9.16/x64/lib/python3.9/site-packages/ansys/mapdl/core/_commands/solution/fe_forces.py:docstring of ansys.mapdl.core._commands.solution.fe_forces.FeForces.flist:22: WARNING: Block quote ends without a blank line; unexpected unindent.
/opt/hostedtoolcache/Python/3.9.16/x64/lib/python3.9/site-packages/ansys/mapdl/core/_commands/preproc/elements.py:docstring of ansys.mapdl.core._commands.preproc.elements.Elements.swlist:21: ERROR: Unexpected indentation.
/opt/hostedtoolcache/Python/3.9.16/x64/lib/python3.9/site-packages/ansys/mapdl/core/_commands/preproc/elements.py:docstring of ansys.mapdl.core._commands.preproc.elements.Elements.swlist:18: WARNING: Block quote ends without a blank line; unexpected unindent.
/opt/hostedtoolcache/Python/3.9.16/x64/lib/python3.9/site-packages/ansys/mapdl/core/_commands/preproc/nodes.py:docstring of ansys.mapdl.core._commands.preproc.nodes.Nodes.nlist:48: ERROR: Unexpected indentation.
/opt/hostedtoolcache/Python/3.9.16/x64/lib/python3.9/site-packages/ansys/mapdl/core/_commands/preproc/nodes.py:docstring of ansys.mapdl.core._commands.preproc.nodes.Nodes.nlist:45: WARNING: Block quote ends without a blank line; unexpected unindent.
/opt/hostedtoolcache/Python/3.9.16/x64/lib/python3.9/site-packages/ansys/mapdl/core/_commands/post26_/status.py:docstring of ansys.mapdl.core._commands.post26_.status.Status.print:16: ERROR: Unexpected indentation.
/opt/hostedtoolcache/Python/3.9.16/x64/lib/python3.9/site-packages/ansys/mapdl/core/_commands/post26_/status.py:docstring of ansys.mapdl.core._commands.post26_.status.Status.print:13: WARNING: Block quote ends without a blank line; unexpected unindent.
/opt/hostedtoolcache/Python/3.9.16/x64/lib/python3.9/site-packages/ansys/mapdl/core/_commands/post1_/results.py:docstring of ansys.mapdl.core._commands.post1_.results.Results.prcint:64: ERROR: Unexpected indentation.
/opt/hostedtoolcache/Python/3.9.16/x64/lib/python3.9/site-packages/ansys/mapdl/core/_commands/post1_/results.py:docstring of ansys.mapdl.core._commands.post1_.results.Results.prcint:61: WARNING: Block quote ends without a blank line; unexpected unindent.
/opt/hostedtoolcache/Python/3.9.16/x64/lib/python3.9/site-packages/ansys/mapdl/core/_commands/post1_/results.py:docstring of ansys.mapdl.core._commands.post1_.results.Results.prenergy:32: ERROR: Unexpected indentation.
/opt/hostedtoolcache/Python/3.9.16/x64/lib/python3.9/site-packages/ansys/mapdl/core/_commands/post1_/results.py:docstring of ansys.mapdl.core._commands.post1_.results.Results.prenergy:29: WARNING: Block quote ends without a blank line; unexpected unindent.
/opt/hostedtoolcache/Python/3.9.16/x64/lib/python3.9/site-packages/ansys/mapdl/core/_commands/post1_/listing.py:docstring of ansys.mapdl.core._commands.post1_.listing.Listing.prerr:16: ERROR: Unexpected indentation.
/opt/hostedtoolcache/Python/3.9.16/x64/lib/python3.9/site-packages/ansys/mapdl/core/_commands/post1_/listing.py:docstring of ansys.mapdl.core._commands.post1_.listing.Listing.prerr:13: WARNING: Block quote ends without a blank line; unexpected unindent.
/opt/hostedtoolcache/Python/3.9.16/x64/lib/python3.9/site-packages/ansys/mapdl/core/_commands/post1_/results.py:docstring of ansys.mapdl.core._commands.post1_.results.Results.presol:27: ERROR: Unexpected indentation.
/opt/hostedtoolcache/Python/3.9.16/x64/lib/python3.9/site-packages/ansys/mapdl/core/_commands/post1_/results.py:docstring of ansys.mapdl.core._commands.post1_.results.Results.presol:24: WARNING: Block quote ends without a blank line; unexpected unindent.
/opt/hostedtoolcache/Python/3.9.16/x64/lib/python3.9/site-packages/ansys/mapdl/core/_commands/post1_/element_table.py:docstring of ansys.mapdl.core._commands.post1_.element_table.ElementTable.pretab:27: ERROR: Unexpected indentation.
/opt/hostedtoolcache/Python/3.9.16/x64/lib/python3.9/site-packages/ansys/mapdl/core/_commands/post1_/element_table.py:docstring of ansys.mapdl.core._commands.post1_.element_table.ElementTable.pretab:24: WARNING: Block quote ends without a blank line; unexpected unindent.
/opt/hostedtoolcache/Python/3.9.16/x64/lib/python3.9/site-packages/ansys/mapdl/core/_commands/post1_/listing.py:docstring of ansys.mapdl.core._commands.post1_.listing.Listing.priter:16: ERROR: Unexpected indentation.
/opt/hostedtoolcache/Python/3.9.16/x64/lib/python3.9/site-packages/ansys/mapdl/core/_commands/post1_/listing.py:docstring of ansys.mapdl.core._commands.post1_.listing.Listing.priter:13: WARNING: Block quote ends without a blank line; unexpected unindent.
/opt/hostedtoolcache/Python/3.9.16/x64/lib/python3.9/site-packages/ansys/mapdl/core/_commands/post1_/results.py:docstring of ansys.mapdl.core._commands.post1_.results.Results.prjsol:40: ERROR: Unexpected indentation.
/opt/hostedtoolcache/Python/3.9.16/x64/lib/python3.9/site-packages/ansys/mapdl/core/_commands/post1_/results.py:docstring of ansys.mapdl.core._commands.post1_.results.Results.prjsol:37: WARNING: Block quote ends without a blank line; unexpected unindent.
/opt/hostedtoolcache/Python/3.9.16/x64/lib/python3.9/site-packages/ansys/mapdl/core/_commands/post1_/results.py:docstring of ansys.mapdl.core._commands.post1_.results.Results.prnld:44: ERROR: Unexpected indentation.
/opt/hostedtoolcache/Python/3.9.16/x64/lib/python3.9/site-packages/ansys/mapdl/core/_commands/post1_/results.py:docstring of ansys.mapdl.core._commands.post1_.results.Results.prnld:41: WARNING: Block quote ends without a blank line; unexpected unindent.
/opt/hostedtoolcache/Python/3.9.16/x64/lib/python3.9/site-packages/ansys/mapdl/core/_commands/post1_/results.py:docstring of ansys.mapdl.core._commands.post1_.results.Results.prnsol:27: ERROR: Unexpected indentation.
/opt/hostedtoolcache/Python/3.9.16/x64/lib/python3.9/site-packages/ansys/mapdl/core/_commands/post1_/results.py:docstring of ansys.mapdl.core._commands.post1_.results.Results.prnsol:24: WARNING: Block quote ends without a blank line; unexpected unindent.
/opt/hostedtoolcache/Python/3.9.16/x64/lib/python3.9/site-packages/ansys/mapdl/core/_commands/post1_/results.py:docstring of ansys.mapdl.core._commands.post1_.results.Results.prorb:16: ERROR: Unexpected indentation.
/opt/hostedtoolcache/Python/3.9.16/x64/lib/python3.9/site-packages/ansys/mapdl/core/_commands/post1_/results.py:docstring of ansys.mapdl.core._commands.post1_.results.Results.prorb:13: WARNING: Block quote ends without a blank line; unexpected unindent.
/opt/hostedtoolcache/Python/3.9.16/x64/lib/python3.9/site-packages/ansys/mapdl/core/_commands/post1_/path_operations.py:docstring of ansys.mapdl.core._commands.post1_.path_operations.PathOperations.prpath:22: ERROR: Unexpected indentation.
/opt/hostedtoolcache/Python/3.9.16/x64/lib/python3.9/site-packages/ansys/mapdl/core/_commands/post1_/path_operations.py:docstring of ansys.mapdl.core._commands.post1_.path_operations.PathOperations.prpath:19: WARNING: Block quote ends without a blank line; unexpected unindent.
/opt/hostedtoolcache/Python/3.9.16/x64/lib/python3.9/site-packages/ansys/mapdl/core/_commands/post1_/results.py:docstring of ansys.mapdl.core._commands.post1_.results.Results.prrfor:22: ERROR: Unexpected indentation.
/opt/hostedtoolcache/Python/3.9.16/x64/lib/python3.9/site-packages/ansys/mapdl/core/_commands/post1_/results.py:docstring of ansys.mapdl.core._commands.post1_.results.Results.prrfor:19: WARNING: Block quote ends without a blank line; unexpected unindent.
/opt/hostedtoolcache/Python/3.9.16/x64/lib/python3.9/site-packages/ansys/mapdl/core/_commands/post1_/results.py:docstring of ansys.mapdl.core._commands.post1_.results.Results.prrsol:21: ERROR: Unexpected indentation.
/opt/hostedtoolcache/Python/3.9.16/x64/lib/python3.9/site-packages/ansys/mapdl/core/_commands/post1_/results.py:docstring of ansys.mapdl.core._commands.post1_.results.Results.prrsol:18: WARNING: Block quote ends without a blank line; unexpected unindent.
/opt/hostedtoolcache/Python/3.9.16/x64/lib/python3.9/site-packages/ansys/mapdl/core/_commands/post1_/path_operations.py:docstring of ansys.mapdl.core._commands.post1_.path_operations.PathOperations.prsect:36: ERROR: Unexpected indentation.
/opt/hostedtoolcache/Python/3.9.16/x64/lib/python3.9/site-packages/ansys/mapdl/core/_commands/post1_/path_operations.py:docstring of ansys.mapdl.core._commands.post1_.path_operations.PathOperations.prsect:33: WARNING: Block quote ends without a blank line; unexpected unindent.
/opt/hostedtoolcache/Python/3.9.16/x64/lib/python3.9/site-packages/ansys/mapdl/core/_commands/post1_/results.py:docstring of ansys.mapdl.core._commands.post1_.results.Results.prvect:38: ERROR: Unexpected indentation.
/opt/hostedtoolcache/Python/3.9.16/x64/lib/python3.9/site-packages/ansys/mapdl/core/_commands/post1_/results.py:docstring of ansys.mapdl.core._commands.post1_.results.Results.prvect:35: WARNING: Block quote ends without a blank line; unexpected unindent.
looking for now-outdated files... none found
pickling environment... done
checking consistency... done

akaszynski · 2023-04-18T16:39:51Z

I'm having some issues with injecting documentation in docstring. It does not make sense

My guess is that this is due to bumping the cache.

* adding ansys-tools-path dependencies * Removing functions * Reorg a bit * Removing tests * Updating docs * Removing orphan test * fixing one test * Getting rid of get_ansys_bin * Getting rid of get_ansys_bin * fix * Removing calls to _get_available_ansys_installations. * Fixing test ubuntu * Using find_ansys to get latest. * Fixing tests * Removing duplicated skipif * fixing version number on remote instance * Small improvement in makefile * resetting cache * adding tests * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * fixing doc warnings * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * removing warning directive * Adding missing pyiges package --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

germa89 added 5 commits April 17, 2023 10:54

adding ansys-tools-path dependencies

d05e66a

Removing functions

50edb6b

Reorg a bit

e14e171

Removing tests

7bb1d4c

Updating docs

336b22f

germa89 self-assigned this Apr 17, 2023

germa89 added the Enhancement Improve any current implemented feature label Apr 17, 2023

germa89 requested review from a team and clatapie and removed request for a team April 17, 2023 04:28

github-actions bot added Dependencies Documentation Documentation related (improving, adding, etc) Maintenance General maintenance of the repo (libraries, cicd, etc) New Feature Request or proposal for a new feature labels Apr 17, 2023

germa89 added 2 commits April 17, 2023 12:47

Removing orphan test

1d8c3ad

fixing one test

2083246

germa89 added 3 commits April 17, 2023 15:15

Getting rid of get_ansys_bin

000d705

Getting rid of get_ansys_bin

96696bf

fix

da013e1

clatapie approved these changes Apr 17, 2023

View reviewed changes

germa89 and others added 9 commits April 17, 2023 21:32

Removing calls to _get_available_ansys_installations.

8a9f2da

Fixing test ubuntu

b1bb0d8

Using find_ansys to get latest.

54ed7ca

Fixing tests

f897bab

Removing duplicated skipif

a0334fb

fixing version number on remote instance

1be2c0f

Small improvement in makefile

d499693

resetting cache

219acc2

Merge branch 'main' into feat/using-ansys-tools-path

b6cc760

germa89 and others added 5 commits April 18, 2023 10:44

adding tests

80b69b8

[pre-commit.ci] auto fixes from pre-commit.com hooks

f64ffa9

for more information, see https://pre-commit.ci

fixing doc warnings

8814b16

[pre-commit.ci] auto fixes from pre-commit.com hooks

d6e081e

for more information, see https://pre-commit.ci

removing warning directive

464c445

akaszynski changed the title ~~Using ansys-tools-path package~~ Use ansys-tools-path package Apr 18, 2023

germa89 and others added 3 commits April 19, 2023 18:35

Merging main

fe5bfc9

Merge branch 'main' into feat/using-ansys-tools-path

57cee95

Adding missing pyiges package

1e12778

germa89 merged commit 8bd085f into main Apr 23, 2023
23 checks passed

germa89 deleted the feat/using-ansys-tools-path branch April 23, 2023 06:39

germa89 mentioned this pull request Apr 24, 2023

Sphinx does not inject the extra methods in docstrings #1999

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Use ansys-tools-path package #1995

Use ansys-tools-path package #1995

germa89 commented Apr 17, 2023

codecov bot commented Apr 17, 2023 •

edited

clatapie left a comment

germa89 commented Apr 18, 2023

akaszynski commented Apr 18, 2023

Use ansys-tools-path package #1995

Use ansys-tools-path package #1995

Conversation

germa89 commented Apr 17, 2023

codecov bot commented Apr 17, 2023 • edited

Codecov Report

clatapie left a comment

Choose a reason for hiding this comment

germa89 commented Apr 18, 2023

Error:

akaszynski commented Apr 18, 2023

codecov bot commented Apr 17, 2023 •

edited