-
Notifications
You must be signed in to change notification settings - Fork 155
Expand file tree
/
Copy path_polyglot.py
More file actions
150 lines (116 loc) · 5.98 KB
/
Copy path_polyglot.py
File metadata and controls
150 lines (116 loc) · 5.98 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
# Copyright (c) 2023, 2026, Oracle and/or its affiliates. All rights reserved.
# DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
#
# The Universal Permissive License (UPL), Version 1.0
#
# Subject to the condition set forth below, permission is hereby granted to any
# person obtaining a copy of this software, associated documentation and/or
# data (collectively the "Software"), free of charge and under any and all
# copyright rights in the Software, and any and all patent rights owned or
# freely licensable by each licensor hereunder covering either (i) the
# unmodified Software as contributed to or provided by such licensor, or (ii)
# the Larger Works (as defined below), to deal in both
#
# (a) the Software, and
#
# (b) any piece of software and/or hardware listed in the lrgrwrks.txt file if
# one is included with the Software each a "Larger Work" to which the Software
# is contributed by such licensors),
#
# without restriction, including without limitation the rights to copy, create
# derivative works of, display, perform, and distribute the Software and make,
# use, sell, offer for sale, import, export, have made, and have sold the
# Software and the Larger Work(s), and to sublicense the foregoing rights on
# either these or other terms.
#
# This license is subject to the following condition:
#
# The above copyright notice and either this complete permission notice or at a
# minimum a reference to the UPL must be included in all copies or substantial
# portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.
import polyglot
def interop_type(foreign_class, allow_method_overwrites=False):
"""
@interop_type(foreign_class, allow_method_overwrites=False)
Registers the annotated python class for the given foreign_class.
Every instance of foreign_class or its subclasses will be treated as an instance of pythonClass.
Multiple registrations per foreign_class are allowed.
If two registered classes for the same foreign_class define the same method, an error will be raised.
If allow_method_overwrites=True, defining the same method is explicitly allowed.
In case of method conflicts, the newest registered class "wins".
Example registering a custom interop type for the java class YourClass
>>> from polyglot import interop_type
>>> import java
>>> YourClass = java.type("fully.qualified.package.path.YourClass")
>>> @polyglot.interop_type(YourClass)
>>> class JYourClass:
... def __str__(self):
... return self.getClass().getSimpleName()
>>> yourClassObject = YourClass()
>>> print(yourClassObject)
YourClass
Per default registering classes with the same methods for one foreign_class raises an error.
If you want to overwrite methods defined in JYourClass use "allow_method_overwrites=True":
>>> @polyglot.interop_type(YourClass, allow_method_overwrites=True)
>>> class NewJYourClass:
... def __str__(self):
... return self.getClass().getName()
>>> print(yourClassObject) # Note: yourClassObject is still the same instance
fully.qualified.package.path.YourClass
"""
def wrapper(python_class):
polyglot.register_interop_type(foreign_class, python_class, allow_method_overwrites=allow_method_overwrites)
# return python class to allow multiple @interop_type
return python_class
return wrapper
setattr(polyglot, "interop_type", interop_type)
def interop_behavior(receiver):
if not isinstance(receiver, type):
raise ValueError(f"The first argument must be a type, not {receiver}")
def wrapper(python_class):
if not isinstance(python_class, type):
raise ValueError(f"The first argument must be a python class, not {python_class}")
# extracting the function from the staticmethod with __func__
messages = {key: value.__func__ for key, value in vars(python_class).items() if isinstance(value, staticmethod)}
polyglot.register_interop_behavior(receiver, **messages)
return python_class
return wrapper
setattr(polyglot, "interop_behavior", interop_behavior)
class gil_locked_during_interop():
"""
A context manager to set if the global interpreter lock (GIL) should
be held when interacting with foreign objects. By default, it is released,
because the foreign object may be doing any kind of operation that either
is long running or blocking in some way, and then no other Python code
could run during that time on other threads. This can even lead to deadlocks
if the foreign language is able to spawn new threads and on those threads
tries to call back into Python.
However, for short calls to foreign objects, the overhead of repeatedly
(un)locking the GIL can be significant, so this context manager can be
used to explicitly control this behavior in a scope using either `true`
or `false` as argument to the initializer.
"""
def __init__(self, lock):
self.lock = lock
def __enter__(self):
self.lock = polyglot.__set_gil_locked_during_foreign_calls__(self.lock)
def __exit__(self, *args):
polyglot.__set_gil_locked_during_foreign_calls__(self.lock)
setattr(polyglot, "gil_locked_during_interop", gil_locked_during_interop)
# loading arrow structures on demand
def __getattr__(name):
if name == "arrow":
import _polyglot_arrow
setattr(polyglot, "arrow", _polyglot_arrow)
return _polyglot_arrow
raise AttributeError(f"module 'polyglot' has no attribute '{name}'")
setattr(polyglot, "__getattr__", __getattr__)
setattr(polyglot, "__path__", ".")