-
Notifications
You must be signed in to change notification settings - Fork 14
Adding more C# examples #12
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
Merged
Merged
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
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 |
|---|---|---|
|
|
@@ -517,13 +517,74 @@ which may be called at startup without having acquired the GIL. | |
|
|
||
| When finished using Python APIs, managed code must call a corresponding | ||
| `PythonEngine.ReleaseLock` to release the GIL and allow other threads | ||
| to use Python. | ||
| to use Python: | ||
|
|
||
| ```csharp | ||
| IntPtr gilState = PythonEngine.AcquireLock(); | ||
|
|
||
| PythonEngine.Exec("doStuff()"); | ||
|
|
||
| PythonEngine.ReleaseLock(gilState); | ||
| ``` | ||
|
|
||
| A `using` statement may also be used to acquire and release the GIL: | ||
|
|
||
| ```csharp | ||
| using (Py.GIL()) | ||
| { | ||
| PythonEngine.Exec("doStuff()"); | ||
| } | ||
| ``` | ||
|
|
||
| The AcquireLock and ReleaseLock methods are thin wrappers over the | ||
| unmanaged `PyGILState_Ensure` and `PyGILState_Release` functions from | ||
| the Python API, and the documentation for those APIs applies to | ||
| the managed versions. | ||
|
|
||
| ## Passing C# Objects to the Python Engine | ||
|
|
||
| This section demonstrates how to pass a C# object to the Python runtime. | ||
| The example uses the following `Person` class: | ||
|
|
||
| ```csharp | ||
| public class Person | ||
| { | ||
| public Person(string firstName, string lastName) | ||
| { | ||
| FirstName = firstName; | ||
| LastName = lastName; | ||
| } | ||
|
|
||
| public string FirstName { get; set; } | ||
| public string LastName { get; set; } | ||
| } | ||
| ``` | ||
|
|
||
| In order to pass a C# object to the Python runtime, it must be converted to a | ||
| `PyObject`. This is done using the `ToPython` extension method. The `PyObject` | ||
| may then be added to a dictionary of local variables and passed to the | ||
| `PythonEngine.Exec` function: | ||
|
|
||
| ```csharp | ||
| // create a person object | ||
| Person person = new Person("John", "Smith"); | ||
|
|
||
| // acquire the GIL before using the Python interpreter | ||
| using (Py.GIL()) | ||
| { | ||
| // convert the Person object to a PyObject | ||
| PyObject pyPerson = person.ToPython(); | ||
|
|
||
| // create a Python variable "person" | ||
| PyDict locals = new PyDict(); | ||
| locals["person"] = pyPerson; | ||
|
||
|
|
||
| // the person object may now be used in Python | ||
| string code = "fullName = person.FirstName + ' ' + person.LastName"; | ||
| PythonEngine.Exec(code, null, locals.Handle); | ||
| } | ||
| ``` | ||
|
|
||
| ## License | ||
|
|
||
| Python for .NET is released under the open source MIT License. | ||
|
|
||
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.
We should not encourage this, the
Py.GILpart should be enough.