Skip to content

Commit 14d5f8c

Browse files
marian-codemarian-code
committed
write multi connection docs, add pickle and deepcopy cupport to simple connection
1 parent 076b5ed commit 14d5f8c

File tree

21 files changed

+385
-738
lines changed

21 files changed

+385
-738
lines changed

‎docs/requirements.txt‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
sphinx-rtd-theme==0.5.0
1+
sphinx-rtd-theme>=0.5.0

‎docs/source/api.rst‎

Lines changed: 8 additions & 73 deletions
Original file line numberDiff line numberDiff line change
@@ -27,79 +27,14 @@ ssh_utilities.connection
2727
.. automodule:: ssh_utilities.connection
2828
:members:
2929

30-
ssh_utilities.base
31-
-------------------
32-
.. automodule:: ssh_utilities.base
33-
:members:
34-
35-
ssh_utilities.remote
36-
--------------------
37-
.. automodule:: ssh_utilities.remote
38-
:members:
39-
40-
ssh_utilities.remote._builtins
41-
------------------------------
42-
.. automodule:: ssh_utilities.remote._builtins
43-
:members:
44-
45-
ssh_utilities.remote._os
46-
------------------------
47-
.. automodule:: ssh_utilities.remote._os
48-
:members:
49-
50-
ssh_utilities.remote._pathlib
51-
-----------------------------
52-
.. automodule:: ssh_utilities.remote._pathlib
53-
:members:
54-
55-
ssh_utilities.remote._shutil
56-
----------------------------
57-
.. automodule:: ssh_utilities.remote._shutil
58-
:members:
59-
60-
ssh_utilities.remote._subprocess
61-
--------------------------------
62-
.. automodule:: ssh_utilities.remote._subprocess
63-
:members:
64-
65-
ssh_utilities.remote.path
66-
-------------------------
67-
.. automodule:: ssh_utilities.remote.path
68-
:members:
69-
70-
ssh_utilities.remote._connection_wrapper
71-
----------------------------------------
72-
.. automodule:: ssh_utilities.remote._connection_wrapper
73-
:members:
74-
75-
ssh_utilities.local
76-
-------------------
77-
.. automodule:: ssh_utilities.local
78-
:members:
79-
80-
ssh_utilities.local._builtins
81-
-----------------------------
82-
.. automodule:: ssh_utilities.local._builtins
83-
:members:
84-
85-
ssh_utilities.local._os
86-
-----------------------
87-
.. automodule:: ssh_utilities.local._os
88-
:members:
89-
90-
ssh_utilities.local._pathlib
91-
----------------------------
92-
.. automodule:: ssh_utilities.local._pathlib
93-
:members:
94-
95-
ssh_utilities.local._shutil
96-
---------------------------
97-
.. automodule:: ssh_utilities.local._shutil
98-
:members:
99-
100-
ssh_utilities.local._subprocess
101-
-------------------------------
102-
.. automodule:: ssh_utilities.local._subprocess
30+
.. toctree::
31+
:maxdepth: 2
32+
:caption: Contents:
33+
34+
api/base
35+
api/local
36+
api/remote
37+
api/multi
10338

10439
ssh_utilities.utils
10540
-------------------

‎docs/source/api/base.rst‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
Connection abstact base classes API
2+
===================================
3+
4+
This file describes abstract classes defining the package API.
5+
6+
ssh_utilities.base
7+
------------------
8+
.. automodule:: ssh_utilities.base
9+
:members:
10+
11+
ssh_utilities.base._connection
12+
------------------------------
13+
.. automodule:: ssh_utilities.base._connection
14+
:members:
15+
16+
ssh_utilities.base._builtins
17+
----------------------------
18+
.. automodule:: ssh_utilities.base._builtins
19+
:members:
20+
21+
ssh_utilities.base._os
22+
----------------------
23+
.. automodule:: ssh_utilities.base._os
24+
:members:
25+
26+
ssh_utilities.base._pathlib
27+
---------------------------
28+
.. automodule:: ssh_utilities.base._pathlib
29+
:members:
30+
31+
ssh_utilities.base._shutil
32+
--------------------------
33+
.. automodule:: ssh_utilities.base._shutil
34+
:members:
35+
36+
ssh_utilities.base._subprocess
37+
------------------------------
38+
.. automodule:: ssh_utilities.base._subprocess
39+
:members:

‎docs/source/api/local.rst‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
Connection local classes
2+
========================
3+
4+
This file describe classes which emulate the remote API on local machine.
5+
6+
ssh_utilities.local
7+
-------------------
8+
.. automodule:: ssh_utilities.local
9+
:members:
10+
11+
ssh_utilities.local._builtins
12+
-----------------------------
13+
.. automodule:: ssh_utilities.local._builtins
14+
:members:
15+
16+
ssh_utilities.local._os
17+
-----------------------
18+
.. automodule:: ssh_utilities.local._os
19+
:members:
20+
21+
ssh_utilities.local._pathlib
22+
----------------------------
23+
.. automodule:: ssh_utilities.local._pathlib
24+
:members:
25+
26+
ssh_utilities.local._shutil
27+
---------------------------
28+
.. automodule:: ssh_utilities.local._shutil
29+
:members:
30+
31+
ssh_utilities.local._subprocess
32+
-------------------------------
33+
.. automodule:: ssh_utilities.local._subprocess

‎docs/source/api/multi.rst‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
Connection multi classes
2+
========================
3+
4+
This file describes the utility wrapper for multiple connections.
5+
6+
ssh_utilities.multi_connection
7+
------------------------------
8+
.. automodule:: ssh_utilities.multi_connection
9+
:members:
10+
11+
ssh_utilities.multi_connection._delegated
12+
-----------------------------------------
13+
.. automodule:: ssh_utilities.multi_connection._delegated
14+
:members:
15+
16+
ssh_utilities.multi_connection._dict_interface
17+
----------------------------------------------
18+
.. automodule:: ssh_utilities.multi_connection._dict_interface
19+
:members:
20+
21+
ssh_utilities.multi_connection._persistence
22+
-------------------------------------------
23+
.. automodule:: ssh_utilities.multi_connection._persistence
24+
:members:

‎docs/source/api/remote.rst‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
Connection remote classes
2+
=========================
3+
4+
This file describes the main package classes API for interacting with remote
5+
hosts.
6+
7+
ssh_utilities.remote
8+
--------------------
9+
.. automodule:: ssh_utilities.remote
10+
:members:
11+
12+
ssh_utilities.remote._builtins
13+
------------------------------
14+
.. automodule:: ssh_utilities.remote._builtins
15+
:members:
16+
17+
ssh_utilities.remote._os
18+
------------------------
19+
.. automodule:: ssh_utilities.remote._os
20+
:members:
21+
22+
ssh_utilities.remote._pathlib
23+
-----------------------------
24+
.. automodule:: ssh_utilities.remote._pathlib
25+
:members:
26+
27+
ssh_utilities.remote._shutil
28+
----------------------------
29+
.. automodule:: ssh_utilities.remote._shutil
30+
:members:
31+
32+
ssh_utilities.remote._subprocess
33+
--------------------------------
34+
.. automodule:: ssh_utilities.remote._subprocess
35+
:members:
36+
37+
ssh_utilities.remote.path
38+
-------------------------
39+
.. automodule:: ssh_utilities.remote.path
40+
:members:
41+
42+
ssh_utilities.remote._connection_wrapper
43+
----------------------------------------
44+
.. automodule:: ssh_utilities.remote._connection_wrapper
45+
:members:

‎docs/source/index.rst‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ Projects home directory is on github:
2020
api
2121
usage_conn
2222
usage_path
23+
usage_multi
2324
migration
2425

2526
Indices and tables

0 commit comments

Comments
 (0)