-
Notifications
You must be signed in to change notification settings - Fork 74
[#827] Add README text on usage of iRODSSession instances #832
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
d-w-moore
wants to merge
1
commit into
irods:main
Choose a base branch
from
d-w-moore:827.m
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+33
−1
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -41,7 +41,39 @@ Uninstalling | |
| Establishing a (secure) connection | ||
| ---------------------------------- | ||
|
|
||
| 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 way to create the session object, assuming one has | ||
| already successfully set up an client environment via `iinit`, is by using a | ||
| simple `make_session` call: | ||
|
|
||
| ```python | ||
| from irods.helpers import make_session | ||
| sess1 = make_session() | ||
|
|
||
| # Possible patterns include: | ||
| # 1. keeping a ready reference to the session. | ||
|
|
||
| sess1.collections.get(f'/tempZone/home/{session.username}') | ||
| # (... Further instances of calls to the server through sess1 may follow.) | ||
|
|
||
| # or: | ||
| # 2. using the session object with a context manager. | ||
|
|
||
| with make_session() as sess2: | ||
| my_user = sess2.users.get(ses.username) | ||
| # Here, we can have other statements using sess2, and at end | ||
| # of code block, sess2.cleanup() is implicitly called. | ||
|
|
||
| # sess1 retains an idle but reusable connection whereas sess2 does not; i.e. | ||
| # sess1.pool.idle has length 1, and sess2.pool.idle is an empty set. | ||
| # However, both sessions are equally open for further server interactions. | ||
| ``` | ||
|
Comment on lines
+49
to
+70
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I think the comments in the code example should be moved outside of it. They capture the main thing we want to emphasize. |
||
|
|
||
| Of course, we should be careful 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 spurious failure of iRODS client connections. | ||
|
|
||
| Another way of starting a session is to pass iRODS credentials as keyword | ||
| arguments: | ||
|
|
||
| ```python | ||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Consider splitting this into two independent code blocks. That should help the reader see the edges of each approach.