Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
57 changes: 56 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,62 @@ Uninstalling
Establishing a (secure) connection

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This title includes (secure), but SSL/TLS isn't mentioned until the next section.

Consider whether (secure) should be moved or removed?

----------------------------------

One way of starting a session is to pass iRODS credentials as keyword
An `iRODSSession` instance is the interface object through which iRODS server
APIs can be invoked. One can create the object using constructor form directly,

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
APIs can be invoked. One can create the object using constructor form directly,
APIs can be invoked. One can create the object using the constructor form directly,

passing connection and authentication options within the call parameter list:

```python
>>> from irods.session import iRODSSession
>>> with iRODSSession(host='localhost', port=1247, user='bob', password='1234', zone='tempZone') as session:
... # Any number of operations using the 'session' variable can go here.
```

Another way to create the session object, assuming one has already successfully
set up a client environment via `iinit`, is by using the convenience function `make_session`:

```python
>>> from irods.helpers import make_session
>>> session = make_session()
```

Once created, the `iRODSSession` instance can be managed from a choice between two
possible patterns. Firstly, one can allow references to the instance to persist as
is natural for the application. This allows Python interpreter's reference counting to
let the object pass out of scope and destroy the underlying server connection(s) at the
proper time:

```python
home_coll = session.collections.get(f'/tempZone/home/{session.username}')
# (... Further instances of calls to the server through 'session' may follow.)
```
Comment on lines +62 to +71

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The code block on line 68 seems out of place in relation to the text on line 62.

Feels like the code block can be removed entirely?


This casual approach usually ends up being optimal choice in terms efficiency, since

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
This casual approach usually ends up being optimal choice in terms efficiency, since
This casual approach usually ends up being the optimal choice in terms of efficiency, since

connections are expensive to create and destroy, and any given connection to the iRODS
server can be employed consecutively and for disparate purposes without incident.

Alternatively a context manager may be used, thus forcing connections to be
provisionally cleared from the session object once a given block of code has
executed:

```python
with make_session() as session:
my_user = session.users.get(session.username)
# We can have further usage of 'session' in this code block. At the end
# of it, session.cleanup() is implicitly called to remove any idle connections.
```

Either way, the instance remains available for further use afterward, until
destructed.

We should, of course, be mindful of how many still-connected `iRODSSession`
objects we retain references to in an application, as having more of them than
the system can support database connections for can result in the spurious failure
of new connections.

Finer points in connecting to the iRODS server
----------------------------------------------

iRODS credentials may also be passed as keyword
arguments:

```python
Expand Down
Loading