id
int32 0
252k
| repo
stringlengths 7
55
| path
stringlengths 4
127
| func_name
stringlengths 1
88
| original_string
stringlengths 75
19.8k
| language
stringclasses 1
value | code
stringlengths 75
19.8k
| code_tokens
list | docstring
stringlengths 3
17.3k
| docstring_tokens
list | sha
stringlengths 40
40
| url
stringlengths 87
242
|
|---|---|---|---|---|---|---|---|---|---|---|---|
233,900
|
picklepete/pyicloud
|
pyicloud/services/contacts.py
|
ContactsService.refresh_client
|
def refresh_client(self, from_dt=None, to_dt=None):
"""
Refreshes the ContactsService endpoint, ensuring that the
contacts data is up-to-date.
"""
params_contacts = dict(self.params)
params_contacts.update({
'clientVersion': '2.1',
'locale': 'en_US',
'order': 'last,first',
})
req = self.session.get(
self._contacts_refresh_url,
params=params_contacts
)
self.response = req.json()
params_refresh = dict(self.params)
params_refresh.update({
'prefToken': req.json()["prefToken"],
'syncToken': req.json()["syncToken"],
})
self.session.post(self._contacts_changeset_url, params=params_refresh)
req = self.session.get(
self._contacts_refresh_url,
params=params_contacts
)
self.response = req.json()
|
python
|
def refresh_client(self, from_dt=None, to_dt=None):
"""
Refreshes the ContactsService endpoint, ensuring that the
contacts data is up-to-date.
"""
params_contacts = dict(self.params)
params_contacts.update({
'clientVersion': '2.1',
'locale': 'en_US',
'order': 'last,first',
})
req = self.session.get(
self._contacts_refresh_url,
params=params_contacts
)
self.response = req.json()
params_refresh = dict(self.params)
params_refresh.update({
'prefToken': req.json()["prefToken"],
'syncToken': req.json()["syncToken"],
})
self.session.post(self._contacts_changeset_url, params=params_refresh)
req = self.session.get(
self._contacts_refresh_url,
params=params_contacts
)
self.response = req.json()
|
[
"def",
"refresh_client",
"(",
"self",
",",
"from_dt",
"=",
"None",
",",
"to_dt",
"=",
"None",
")",
":",
"params_contacts",
"=",
"dict",
"(",
"self",
".",
"params",
")",
"params_contacts",
".",
"update",
"(",
"{",
"'clientVersion'",
":",
"'2.1'",
",",
"'locale'",
":",
"'en_US'",
",",
"'order'",
":",
"'last,first'",
",",
"}",
")",
"req",
"=",
"self",
".",
"session",
".",
"get",
"(",
"self",
".",
"_contacts_refresh_url",
",",
"params",
"=",
"params_contacts",
")",
"self",
".",
"response",
"=",
"req",
".",
"json",
"(",
")",
"params_refresh",
"=",
"dict",
"(",
"self",
".",
"params",
")",
"params_refresh",
".",
"update",
"(",
"{",
"'prefToken'",
":",
"req",
".",
"json",
"(",
")",
"[",
"\"prefToken\"",
"]",
",",
"'syncToken'",
":",
"req",
".",
"json",
"(",
")",
"[",
"\"syncToken\"",
"]",
",",
"}",
")",
"self",
".",
"session",
".",
"post",
"(",
"self",
".",
"_contacts_changeset_url",
",",
"params",
"=",
"params_refresh",
")",
"req",
"=",
"self",
".",
"session",
".",
"get",
"(",
"self",
".",
"_contacts_refresh_url",
",",
"params",
"=",
"params_contacts",
")",
"self",
".",
"response",
"=",
"req",
".",
"json",
"(",
")"
] |
Refreshes the ContactsService endpoint, ensuring that the
contacts data is up-to-date.
|
[
"Refreshes",
"the",
"ContactsService",
"endpoint",
"ensuring",
"that",
"the",
"contacts",
"data",
"is",
"up",
"-",
"to",
"-",
"date",
"."
] |
9bb6d750662ce24c8febc94807ddbdcdf3cadaa2
|
https://github.com/picklepete/pyicloud/blob/9bb6d750662ce24c8febc94807ddbdcdf3cadaa2/pyicloud/services/contacts.py#L20-L46
|
233,901
|
picklepete/pyicloud
|
pyicloud/base.py
|
PyiCloudService.authenticate
|
def authenticate(self):
"""
Handles authentication, and persists the X-APPLE-WEB-KB cookie so that
subsequent logins will not cause additional e-mails from Apple.
"""
logger.info("Authenticating as %s", self.user['apple_id'])
data = dict(self.user)
# We authenticate every time, so "remember me" is not needed
data.update({'extended_login': False})
try:
req = self.session.post(
self._base_login_url,
params=self.params,
data=json.dumps(data)
)
except PyiCloudAPIResponseError as error:
msg = 'Invalid email/password combination.'
raise PyiCloudFailedLoginException(msg, error)
resp = req.json()
self.params.update({'dsid': resp['dsInfo']['dsid']})
if not os.path.exists(self._cookie_directory):
os.mkdir(self._cookie_directory)
self.session.cookies.save()
logger.debug("Cookies saved to %s", self._get_cookiejar_path())
self.data = resp
self.webservices = self.data['webservices']
logger.info("Authentication completed successfully")
logger.debug(self.params)
|
python
|
def authenticate(self):
"""
Handles authentication, and persists the X-APPLE-WEB-KB cookie so that
subsequent logins will not cause additional e-mails from Apple.
"""
logger.info("Authenticating as %s", self.user['apple_id'])
data = dict(self.user)
# We authenticate every time, so "remember me" is not needed
data.update({'extended_login': False})
try:
req = self.session.post(
self._base_login_url,
params=self.params,
data=json.dumps(data)
)
except PyiCloudAPIResponseError as error:
msg = 'Invalid email/password combination.'
raise PyiCloudFailedLoginException(msg, error)
resp = req.json()
self.params.update({'dsid': resp['dsInfo']['dsid']})
if not os.path.exists(self._cookie_directory):
os.mkdir(self._cookie_directory)
self.session.cookies.save()
logger.debug("Cookies saved to %s", self._get_cookiejar_path())
self.data = resp
self.webservices = self.data['webservices']
logger.info("Authentication completed successfully")
logger.debug(self.params)
|
[
"def",
"authenticate",
"(",
"self",
")",
":",
"logger",
".",
"info",
"(",
"\"Authenticating as %s\"",
",",
"self",
".",
"user",
"[",
"'apple_id'",
"]",
")",
"data",
"=",
"dict",
"(",
"self",
".",
"user",
")",
"# We authenticate every time, so \"remember me\" is not needed",
"data",
".",
"update",
"(",
"{",
"'extended_login'",
":",
"False",
"}",
")",
"try",
":",
"req",
"=",
"self",
".",
"session",
".",
"post",
"(",
"self",
".",
"_base_login_url",
",",
"params",
"=",
"self",
".",
"params",
",",
"data",
"=",
"json",
".",
"dumps",
"(",
"data",
")",
")",
"except",
"PyiCloudAPIResponseError",
"as",
"error",
":",
"msg",
"=",
"'Invalid email/password combination.'",
"raise",
"PyiCloudFailedLoginException",
"(",
"msg",
",",
"error",
")",
"resp",
"=",
"req",
".",
"json",
"(",
")",
"self",
".",
"params",
".",
"update",
"(",
"{",
"'dsid'",
":",
"resp",
"[",
"'dsInfo'",
"]",
"[",
"'dsid'",
"]",
"}",
")",
"if",
"not",
"os",
".",
"path",
".",
"exists",
"(",
"self",
".",
"_cookie_directory",
")",
":",
"os",
".",
"mkdir",
"(",
"self",
".",
"_cookie_directory",
")",
"self",
".",
"session",
".",
"cookies",
".",
"save",
"(",
")",
"logger",
".",
"debug",
"(",
"\"Cookies saved to %s\"",
",",
"self",
".",
"_get_cookiejar_path",
"(",
")",
")",
"self",
".",
"data",
"=",
"resp",
"self",
".",
"webservices",
"=",
"self",
".",
"data",
"[",
"'webservices'",
"]",
"logger",
".",
"info",
"(",
"\"Authentication completed successfully\"",
")",
"logger",
".",
"debug",
"(",
"self",
".",
"params",
")"
] |
Handles authentication, and persists the X-APPLE-WEB-KB cookie so that
subsequent logins will not cause additional e-mails from Apple.
|
[
"Handles",
"authentication",
"and",
"persists",
"the",
"X",
"-",
"APPLE",
"-",
"WEB",
"-",
"KB",
"cookie",
"so",
"that",
"subsequent",
"logins",
"will",
"not",
"cause",
"additional",
"e",
"-",
"mails",
"from",
"Apple",
"."
] |
9bb6d750662ce24c8febc94807ddbdcdf3cadaa2
|
https://github.com/picklepete/pyicloud/blob/9bb6d750662ce24c8febc94807ddbdcdf3cadaa2/pyicloud/base.py#L195-L230
|
233,902
|
picklepete/pyicloud
|
pyicloud/base.py
|
PyiCloudService.trusted_devices
|
def trusted_devices(self):
""" Returns devices trusted for two-step authentication."""
request = self.session.get(
'%s/listDevices' % self._setup_endpoint,
params=self.params
)
return request.json().get('devices')
|
python
|
def trusted_devices(self):
""" Returns devices trusted for two-step authentication."""
request = self.session.get(
'%s/listDevices' % self._setup_endpoint,
params=self.params
)
return request.json().get('devices')
|
[
"def",
"trusted_devices",
"(",
"self",
")",
":",
"request",
"=",
"self",
".",
"session",
".",
"get",
"(",
"'%s/listDevices'",
"%",
"self",
".",
"_setup_endpoint",
",",
"params",
"=",
"self",
".",
"params",
")",
"return",
"request",
".",
"json",
"(",
")",
".",
"get",
"(",
"'devices'",
")"
] |
Returns devices trusted for two-step authentication.
|
[
"Returns",
"devices",
"trusted",
"for",
"two",
"-",
"step",
"authentication",
"."
] |
9bb6d750662ce24c8febc94807ddbdcdf3cadaa2
|
https://github.com/picklepete/pyicloud/blob/9bb6d750662ce24c8febc94807ddbdcdf3cadaa2/pyicloud/base.py#L247-L253
|
233,903
|
picklepete/pyicloud
|
pyicloud/base.py
|
PyiCloudService.send_verification_code
|
def send_verification_code(self, device):
""" Requests that a verification code is sent to the given device"""
data = json.dumps(device)
request = self.session.post(
'%s/sendVerificationCode' % self._setup_endpoint,
params=self.params,
data=data
)
return request.json().get('success', False)
|
python
|
def send_verification_code(self, device):
""" Requests that a verification code is sent to the given device"""
data = json.dumps(device)
request = self.session.post(
'%s/sendVerificationCode' % self._setup_endpoint,
params=self.params,
data=data
)
return request.json().get('success', False)
|
[
"def",
"send_verification_code",
"(",
"self",
",",
"device",
")",
":",
"data",
"=",
"json",
".",
"dumps",
"(",
"device",
")",
"request",
"=",
"self",
".",
"session",
".",
"post",
"(",
"'%s/sendVerificationCode'",
"%",
"self",
".",
"_setup_endpoint",
",",
"params",
"=",
"self",
".",
"params",
",",
"data",
"=",
"data",
")",
"return",
"request",
".",
"json",
"(",
")",
".",
"get",
"(",
"'success'",
",",
"False",
")"
] |
Requests that a verification code is sent to the given device
|
[
"Requests",
"that",
"a",
"verification",
"code",
"is",
"sent",
"to",
"the",
"given",
"device"
] |
9bb6d750662ce24c8febc94807ddbdcdf3cadaa2
|
https://github.com/picklepete/pyicloud/blob/9bb6d750662ce24c8febc94807ddbdcdf3cadaa2/pyicloud/base.py#L255-L263
|
233,904
|
picklepete/pyicloud
|
pyicloud/base.py
|
PyiCloudService.validate_verification_code
|
def validate_verification_code(self, device, code):
""" Verifies a verification code received on a trusted device"""
device.update({
'verificationCode': code,
'trustBrowser': True
})
data = json.dumps(device)
try:
request = self.session.post(
'%s/validateVerificationCode' % self._setup_endpoint,
params=self.params,
data=data
)
except PyiCloudAPIResponseError as error:
if error.code == -21669:
# Wrong verification code
return False
raise
# Re-authenticate, which will both update the HSA data, and
# ensure that we save the X-APPLE-WEBAUTH-HSA-TRUST cookie.
self.authenticate()
return not self.requires_2sa
|
python
|
def validate_verification_code(self, device, code):
""" Verifies a verification code received on a trusted device"""
device.update({
'verificationCode': code,
'trustBrowser': True
})
data = json.dumps(device)
try:
request = self.session.post(
'%s/validateVerificationCode' % self._setup_endpoint,
params=self.params,
data=data
)
except PyiCloudAPIResponseError as error:
if error.code == -21669:
# Wrong verification code
return False
raise
# Re-authenticate, which will both update the HSA data, and
# ensure that we save the X-APPLE-WEBAUTH-HSA-TRUST cookie.
self.authenticate()
return not self.requires_2sa
|
[
"def",
"validate_verification_code",
"(",
"self",
",",
"device",
",",
"code",
")",
":",
"device",
".",
"update",
"(",
"{",
"'verificationCode'",
":",
"code",
",",
"'trustBrowser'",
":",
"True",
"}",
")",
"data",
"=",
"json",
".",
"dumps",
"(",
"device",
")",
"try",
":",
"request",
"=",
"self",
".",
"session",
".",
"post",
"(",
"'%s/validateVerificationCode'",
"%",
"self",
".",
"_setup_endpoint",
",",
"params",
"=",
"self",
".",
"params",
",",
"data",
"=",
"data",
")",
"except",
"PyiCloudAPIResponseError",
"as",
"error",
":",
"if",
"error",
".",
"code",
"==",
"-",
"21669",
":",
"# Wrong verification code",
"return",
"False",
"raise",
"# Re-authenticate, which will both update the HSA data, and",
"# ensure that we save the X-APPLE-WEBAUTH-HSA-TRUST cookie.",
"self",
".",
"authenticate",
"(",
")",
"return",
"not",
"self",
".",
"requires_2sa"
] |
Verifies a verification code received on a trusted device
|
[
"Verifies",
"a",
"verification",
"code",
"received",
"on",
"a",
"trusted",
"device"
] |
9bb6d750662ce24c8febc94807ddbdcdf3cadaa2
|
https://github.com/picklepete/pyicloud/blob/9bb6d750662ce24c8febc94807ddbdcdf3cadaa2/pyicloud/base.py#L265-L289
|
233,905
|
picklepete/pyicloud
|
pyicloud/base.py
|
PyiCloudService.devices
|
def devices(self):
""" Return all devices."""
service_root = self.webservices['findme']['url']
return FindMyiPhoneServiceManager(
service_root,
self.session,
self.params
)
|
python
|
def devices(self):
""" Return all devices."""
service_root = self.webservices['findme']['url']
return FindMyiPhoneServiceManager(
service_root,
self.session,
self.params
)
|
[
"def",
"devices",
"(",
"self",
")",
":",
"service_root",
"=",
"self",
".",
"webservices",
"[",
"'findme'",
"]",
"[",
"'url'",
"]",
"return",
"FindMyiPhoneServiceManager",
"(",
"service_root",
",",
"self",
".",
"session",
",",
"self",
".",
"params",
")"
] |
Return all devices.
|
[
"Return",
"all",
"devices",
"."
] |
9bb6d750662ce24c8febc94807ddbdcdf3cadaa2
|
https://github.com/picklepete/pyicloud/blob/9bb6d750662ce24c8febc94807ddbdcdf3cadaa2/pyicloud/base.py#L292-L299
|
233,906
|
kennethreitz/grequests
|
grequests.py
|
send
|
def send(r, pool=None, stream=False):
"""Sends the request object using the specified pool. If a pool isn't
specified this method blocks. Pools are useful because you can specify size
and can hence limit concurrency."""
if pool is not None:
return pool.spawn(r.send, stream=stream)
return gevent.spawn(r.send, stream=stream)
|
python
|
def send(r, pool=None, stream=False):
"""Sends the request object using the specified pool. If a pool isn't
specified this method blocks. Pools are useful because you can specify size
and can hence limit concurrency."""
if pool is not None:
return pool.spawn(r.send, stream=stream)
return gevent.spawn(r.send, stream=stream)
|
[
"def",
"send",
"(",
"r",
",",
"pool",
"=",
"None",
",",
"stream",
"=",
"False",
")",
":",
"if",
"pool",
"is",
"not",
"None",
":",
"return",
"pool",
".",
"spawn",
"(",
"r",
".",
"send",
",",
"stream",
"=",
"stream",
")",
"return",
"gevent",
".",
"spawn",
"(",
"r",
".",
"send",
",",
"stream",
"=",
"stream",
")"
] |
Sends the request object using the specified pool. If a pool isn't
specified this method blocks. Pools are useful because you can specify size
and can hence limit concurrency.
|
[
"Sends",
"the",
"request",
"object",
"using",
"the",
"specified",
"pool",
".",
"If",
"a",
"pool",
"isn",
"t",
"specified",
"this",
"method",
"blocks",
".",
"Pools",
"are",
"useful",
"because",
"you",
"can",
"specify",
"size",
"and",
"can",
"hence",
"limit",
"concurrency",
"."
] |
ba25872510e06af213b0c209d204cdc913e3a429
|
https://github.com/kennethreitz/grequests/blob/ba25872510e06af213b0c209d204cdc913e3a429/grequests.py#L79-L86
|
233,907
|
kennethreitz/grequests
|
grequests.py
|
imap
|
def imap(requests, stream=False, size=2, exception_handler=None):
"""Concurrently converts a generator object of Requests to
a generator of Responses.
:param requests: a generator of Request objects.
:param stream: If True, the content will not be downloaded immediately.
:param size: Specifies the number of requests to make at a time. default is 2
:param exception_handler: Callback function, called when exception occured. Params: Request, Exception
"""
pool = Pool(size)
def send(r):
return r.send(stream=stream)
for request in pool.imap_unordered(send, requests):
if request.response is not None:
yield request.response
elif exception_handler:
ex_result = exception_handler(request, request.exception)
if ex_result is not None:
yield ex_result
pool.join()
|
python
|
def imap(requests, stream=False, size=2, exception_handler=None):
"""Concurrently converts a generator object of Requests to
a generator of Responses.
:param requests: a generator of Request objects.
:param stream: If True, the content will not be downloaded immediately.
:param size: Specifies the number of requests to make at a time. default is 2
:param exception_handler: Callback function, called when exception occured. Params: Request, Exception
"""
pool = Pool(size)
def send(r):
return r.send(stream=stream)
for request in pool.imap_unordered(send, requests):
if request.response is not None:
yield request.response
elif exception_handler:
ex_result = exception_handler(request, request.exception)
if ex_result is not None:
yield ex_result
pool.join()
|
[
"def",
"imap",
"(",
"requests",
",",
"stream",
"=",
"False",
",",
"size",
"=",
"2",
",",
"exception_handler",
"=",
"None",
")",
":",
"pool",
"=",
"Pool",
"(",
"size",
")",
"def",
"send",
"(",
"r",
")",
":",
"return",
"r",
".",
"send",
"(",
"stream",
"=",
"stream",
")",
"for",
"request",
"in",
"pool",
".",
"imap_unordered",
"(",
"send",
",",
"requests",
")",
":",
"if",
"request",
".",
"response",
"is",
"not",
"None",
":",
"yield",
"request",
".",
"response",
"elif",
"exception_handler",
":",
"ex_result",
"=",
"exception_handler",
"(",
"request",
",",
"request",
".",
"exception",
")",
"if",
"ex_result",
"is",
"not",
"None",
":",
"yield",
"ex_result",
"pool",
".",
"join",
"(",
")"
] |
Concurrently converts a generator object of Requests to
a generator of Responses.
:param requests: a generator of Request objects.
:param stream: If True, the content will not be downloaded immediately.
:param size: Specifies the number of requests to make at a time. default is 2
:param exception_handler: Callback function, called when exception occured. Params: Request, Exception
|
[
"Concurrently",
"converts",
"a",
"generator",
"object",
"of",
"Requests",
"to",
"a",
"generator",
"of",
"Responses",
"."
] |
ba25872510e06af213b0c209d204cdc913e3a429
|
https://github.com/kennethreitz/grequests/blob/ba25872510e06af213b0c209d204cdc913e3a429/grequests.py#L132-L155
|
233,908
|
matrix-org/matrix-python-sdk
|
matrix_client/room.py
|
Room.set_user_profile
|
def set_user_profile(self,
displayname=None,
avatar_url=None,
reason="Changing room profile information"):
"""Set user profile within a room.
This sets displayname and avatar_url for the logged in user only in a
specific room. It does not change the user's global user profile.
"""
member = self.client.api.get_membership(self.room_id, self.client.user_id)
if member["membership"] != "join":
raise Exception("Can't set profile if you have not joined the room.")
if displayname is None:
displayname = member["displayname"]
if avatar_url is None:
avatar_url = member["avatar_url"]
self.client.api.set_membership(
self.room_id,
self.client.user_id,
'join',
reason, {
"displayname": displayname,
"avatar_url": avatar_url
}
)
|
python
|
def set_user_profile(self,
displayname=None,
avatar_url=None,
reason="Changing room profile information"):
"""Set user profile within a room.
This sets displayname and avatar_url for the logged in user only in a
specific room. It does not change the user's global user profile.
"""
member = self.client.api.get_membership(self.room_id, self.client.user_id)
if member["membership"] != "join":
raise Exception("Can't set profile if you have not joined the room.")
if displayname is None:
displayname = member["displayname"]
if avatar_url is None:
avatar_url = member["avatar_url"]
self.client.api.set_membership(
self.room_id,
self.client.user_id,
'join',
reason, {
"displayname": displayname,
"avatar_url": avatar_url
}
)
|
[
"def",
"set_user_profile",
"(",
"self",
",",
"displayname",
"=",
"None",
",",
"avatar_url",
"=",
"None",
",",
"reason",
"=",
"\"Changing room profile information\"",
")",
":",
"member",
"=",
"self",
".",
"client",
".",
"api",
".",
"get_membership",
"(",
"self",
".",
"room_id",
",",
"self",
".",
"client",
".",
"user_id",
")",
"if",
"member",
"[",
"\"membership\"",
"]",
"!=",
"\"join\"",
":",
"raise",
"Exception",
"(",
"\"Can't set profile if you have not joined the room.\"",
")",
"if",
"displayname",
"is",
"None",
":",
"displayname",
"=",
"member",
"[",
"\"displayname\"",
"]",
"if",
"avatar_url",
"is",
"None",
":",
"avatar_url",
"=",
"member",
"[",
"\"avatar_url\"",
"]",
"self",
".",
"client",
".",
"api",
".",
"set_membership",
"(",
"self",
".",
"room_id",
",",
"self",
".",
"client",
".",
"user_id",
",",
"'join'",
",",
"reason",
",",
"{",
"\"displayname\"",
":",
"displayname",
",",
"\"avatar_url\"",
":",
"avatar_url",
"}",
")"
] |
Set user profile within a room.
This sets displayname and avatar_url for the logged in user only in a
specific room. It does not change the user's global user profile.
|
[
"Set",
"user",
"profile",
"within",
"a",
"room",
"."
] |
e734cce3ccd35f2d355c6a19a7a701033472498a
|
https://github.com/matrix-org/matrix-python-sdk/blob/e734cce3ccd35f2d355c6a19a7a701033472498a/matrix_client/room.py#L57-L81
|
233,909
|
matrix-org/matrix-python-sdk
|
matrix_client/room.py
|
Room.display_name
|
def display_name(self):
"""Calculates the display name for a room."""
if self.name:
return self.name
elif self.canonical_alias:
return self.canonical_alias
# Member display names without me
members = [u.get_display_name(self) for u in self.get_joined_members() if
self.client.user_id != u.user_id]
members.sort()
if len(members) == 1:
return members[0]
elif len(members) == 2:
return "{0} and {1}".format(members[0], members[1])
elif len(members) > 2:
return "{0} and {1} others".format(members[0], len(members) - 1)
else: # len(members) <= 0 or not an integer
# TODO i18n
return "Empty room"
|
python
|
def display_name(self):
"""Calculates the display name for a room."""
if self.name:
return self.name
elif self.canonical_alias:
return self.canonical_alias
# Member display names without me
members = [u.get_display_name(self) for u in self.get_joined_members() if
self.client.user_id != u.user_id]
members.sort()
if len(members) == 1:
return members[0]
elif len(members) == 2:
return "{0} and {1}".format(members[0], members[1])
elif len(members) > 2:
return "{0} and {1} others".format(members[0], len(members) - 1)
else: # len(members) <= 0 or not an integer
# TODO i18n
return "Empty room"
|
[
"def",
"display_name",
"(",
"self",
")",
":",
"if",
"self",
".",
"name",
":",
"return",
"self",
".",
"name",
"elif",
"self",
".",
"canonical_alias",
":",
"return",
"self",
".",
"canonical_alias",
"# Member display names without me",
"members",
"=",
"[",
"u",
".",
"get_display_name",
"(",
"self",
")",
"for",
"u",
"in",
"self",
".",
"get_joined_members",
"(",
")",
"if",
"self",
".",
"client",
".",
"user_id",
"!=",
"u",
".",
"user_id",
"]",
"members",
".",
"sort",
"(",
")",
"if",
"len",
"(",
"members",
")",
"==",
"1",
":",
"return",
"members",
"[",
"0",
"]",
"elif",
"len",
"(",
"members",
")",
"==",
"2",
":",
"return",
"\"{0} and {1}\"",
".",
"format",
"(",
"members",
"[",
"0",
"]",
",",
"members",
"[",
"1",
"]",
")",
"elif",
"len",
"(",
"members",
")",
">",
"2",
":",
"return",
"\"{0} and {1} others\"",
".",
"format",
"(",
"members",
"[",
"0",
"]",
",",
"len",
"(",
"members",
")",
"-",
"1",
")",
"else",
":",
"# len(members) <= 0 or not an integer",
"# TODO i18n",
"return",
"\"Empty room\""
] |
Calculates the display name for a room.
|
[
"Calculates",
"the",
"display",
"name",
"for",
"a",
"room",
"."
] |
e734cce3ccd35f2d355c6a19a7a701033472498a
|
https://github.com/matrix-org/matrix-python-sdk/blob/e734cce3ccd35f2d355c6a19a7a701033472498a/matrix_client/room.py#L84-L104
|
233,910
|
matrix-org/matrix-python-sdk
|
matrix_client/room.py
|
Room.send_text
|
def send_text(self, text):
"""Send a plain text message to the room."""
return self.client.api.send_message(self.room_id, text)
|
python
|
def send_text(self, text):
"""Send a plain text message to the room."""
return self.client.api.send_message(self.room_id, text)
|
[
"def",
"send_text",
"(",
"self",
",",
"text",
")",
":",
"return",
"self",
".",
"client",
".",
"api",
".",
"send_message",
"(",
"self",
".",
"room_id",
",",
"text",
")"
] |
Send a plain text message to the room.
|
[
"Send",
"a",
"plain",
"text",
"message",
"to",
"the",
"room",
"."
] |
e734cce3ccd35f2d355c6a19a7a701033472498a
|
https://github.com/matrix-org/matrix-python-sdk/blob/e734cce3ccd35f2d355c6a19a7a701033472498a/matrix_client/room.py#L106-L108
|
233,911
|
matrix-org/matrix-python-sdk
|
matrix_client/room.py
|
Room.send_html
|
def send_html(self, html, body=None, msgtype="m.text"):
"""Send an html formatted message.
Args:
html (str): The html formatted message to be sent.
body (str): The unformatted body of the message to be sent.
"""
return self.client.api.send_message_event(
self.room_id, "m.room.message", self.get_html_content(html, body, msgtype))
|
python
|
def send_html(self, html, body=None, msgtype="m.text"):
"""Send an html formatted message.
Args:
html (str): The html formatted message to be sent.
body (str): The unformatted body of the message to be sent.
"""
return self.client.api.send_message_event(
self.room_id, "m.room.message", self.get_html_content(html, body, msgtype))
|
[
"def",
"send_html",
"(",
"self",
",",
"html",
",",
"body",
"=",
"None",
",",
"msgtype",
"=",
"\"m.text\"",
")",
":",
"return",
"self",
".",
"client",
".",
"api",
".",
"send_message_event",
"(",
"self",
".",
"room_id",
",",
"\"m.room.message\"",
",",
"self",
".",
"get_html_content",
"(",
"html",
",",
"body",
",",
"msgtype",
")",
")"
] |
Send an html formatted message.
Args:
html (str): The html formatted message to be sent.
body (str): The unformatted body of the message to be sent.
|
[
"Send",
"an",
"html",
"formatted",
"message",
"."
] |
e734cce3ccd35f2d355c6a19a7a701033472498a
|
https://github.com/matrix-org/matrix-python-sdk/blob/e734cce3ccd35f2d355c6a19a7a701033472498a/matrix_client/room.py#L118-L126
|
233,912
|
matrix-org/matrix-python-sdk
|
matrix_client/room.py
|
Room.send_file
|
def send_file(self, url, name, **fileinfo):
"""Send a pre-uploaded file to the room.
See http://matrix.org/docs/spec/r0.2.0/client_server.html#m-file for
fileinfo.
Args:
url (str): The mxc url of the file.
name (str): The filename of the image.
fileinfo (): Extra information about the file
"""
return self.client.api.send_content(
self.room_id, url, name, "m.file",
extra_information=fileinfo
)
|
python
|
def send_file(self, url, name, **fileinfo):
"""Send a pre-uploaded file to the room.
See http://matrix.org/docs/spec/r0.2.0/client_server.html#m-file for
fileinfo.
Args:
url (str): The mxc url of the file.
name (str): The filename of the image.
fileinfo (): Extra information about the file
"""
return self.client.api.send_content(
self.room_id, url, name, "m.file",
extra_information=fileinfo
)
|
[
"def",
"send_file",
"(",
"self",
",",
"url",
",",
"name",
",",
"*",
"*",
"fileinfo",
")",
":",
"return",
"self",
".",
"client",
".",
"api",
".",
"send_content",
"(",
"self",
".",
"room_id",
",",
"url",
",",
"name",
",",
"\"m.file\"",
",",
"extra_information",
"=",
"fileinfo",
")"
] |
Send a pre-uploaded file to the room.
See http://matrix.org/docs/spec/r0.2.0/client_server.html#m-file for
fileinfo.
Args:
url (str): The mxc url of the file.
name (str): The filename of the image.
fileinfo (): Extra information about the file
|
[
"Send",
"a",
"pre",
"-",
"uploaded",
"file",
"to",
"the",
"room",
"."
] |
e734cce3ccd35f2d355c6a19a7a701033472498a
|
https://github.com/matrix-org/matrix-python-sdk/blob/e734cce3ccd35f2d355c6a19a7a701033472498a/matrix_client/room.py#L150-L165
|
233,913
|
matrix-org/matrix-python-sdk
|
matrix_client/room.py
|
Room.send_image
|
def send_image(self, url, name, **imageinfo):
"""Send a pre-uploaded image to the room.
See http://matrix.org/docs/spec/r0.0.1/client_server.html#m-image
for imageinfo
Args:
url (str): The mxc url of the image.
name (str): The filename of the image.
imageinfo (): Extra information about the image.
"""
return self.client.api.send_content(
self.room_id, url, name, "m.image",
extra_information=imageinfo
)
|
python
|
def send_image(self, url, name, **imageinfo):
"""Send a pre-uploaded image to the room.
See http://matrix.org/docs/spec/r0.0.1/client_server.html#m-image
for imageinfo
Args:
url (str): The mxc url of the image.
name (str): The filename of the image.
imageinfo (): Extra information about the image.
"""
return self.client.api.send_content(
self.room_id, url, name, "m.image",
extra_information=imageinfo
)
|
[
"def",
"send_image",
"(",
"self",
",",
"url",
",",
"name",
",",
"*",
"*",
"imageinfo",
")",
":",
"return",
"self",
".",
"client",
".",
"api",
".",
"send_content",
"(",
"self",
".",
"room_id",
",",
"url",
",",
"name",
",",
"\"m.image\"",
",",
"extra_information",
"=",
"imageinfo",
")"
] |
Send a pre-uploaded image to the room.
See http://matrix.org/docs/spec/r0.0.1/client_server.html#m-image
for imageinfo
Args:
url (str): The mxc url of the image.
name (str): The filename of the image.
imageinfo (): Extra information about the image.
|
[
"Send",
"a",
"pre",
"-",
"uploaded",
"image",
"to",
"the",
"room",
"."
] |
e734cce3ccd35f2d355c6a19a7a701033472498a
|
https://github.com/matrix-org/matrix-python-sdk/blob/e734cce3ccd35f2d355c6a19a7a701033472498a/matrix_client/room.py#L173-L187
|
233,914
|
matrix-org/matrix-python-sdk
|
matrix_client/room.py
|
Room.send_location
|
def send_location(self, geo_uri, name, thumb_url=None, **thumb_info):
"""Send a location to the room.
See http://matrix.org/docs/spec/client_server/r0.2.0.html#m-location
for thumb_info
Args:
geo_uri (str): The geo uri representing the location.
name (str): Description for the location.
thumb_url (str): URL to the thumbnail of the location.
thumb_info (): Metadata about the thumbnail, type ImageInfo.
"""
return self.client.api.send_location(self.room_id, geo_uri, name,
thumb_url, thumb_info)
|
python
|
def send_location(self, geo_uri, name, thumb_url=None, **thumb_info):
"""Send a location to the room.
See http://matrix.org/docs/spec/client_server/r0.2.0.html#m-location
for thumb_info
Args:
geo_uri (str): The geo uri representing the location.
name (str): Description for the location.
thumb_url (str): URL to the thumbnail of the location.
thumb_info (): Metadata about the thumbnail, type ImageInfo.
"""
return self.client.api.send_location(self.room_id, geo_uri, name,
thumb_url, thumb_info)
|
[
"def",
"send_location",
"(",
"self",
",",
"geo_uri",
",",
"name",
",",
"thumb_url",
"=",
"None",
",",
"*",
"*",
"thumb_info",
")",
":",
"return",
"self",
".",
"client",
".",
"api",
".",
"send_location",
"(",
"self",
".",
"room_id",
",",
"geo_uri",
",",
"name",
",",
"thumb_url",
",",
"thumb_info",
")"
] |
Send a location to the room.
See http://matrix.org/docs/spec/client_server/r0.2.0.html#m-location
for thumb_info
Args:
geo_uri (str): The geo uri representing the location.
name (str): Description for the location.
thumb_url (str): URL to the thumbnail of the location.
thumb_info (): Metadata about the thumbnail, type ImageInfo.
|
[
"Send",
"a",
"location",
"to",
"the",
"room",
"."
] |
e734cce3ccd35f2d355c6a19a7a701033472498a
|
https://github.com/matrix-org/matrix-python-sdk/blob/e734cce3ccd35f2d355c6a19a7a701033472498a/matrix_client/room.py#L189-L202
|
233,915
|
matrix-org/matrix-python-sdk
|
matrix_client/room.py
|
Room.send_video
|
def send_video(self, url, name, **videoinfo):
"""Send a pre-uploaded video to the room.
See http://matrix.org/docs/spec/client_server/r0.2.0.html#m-video
for videoinfo
Args:
url (str): The mxc url of the video.
name (str): The filename of the video.
videoinfo (): Extra information about the video.
"""
return self.client.api.send_content(self.room_id, url, name, "m.video",
extra_information=videoinfo)
|
python
|
def send_video(self, url, name, **videoinfo):
"""Send a pre-uploaded video to the room.
See http://matrix.org/docs/spec/client_server/r0.2.0.html#m-video
for videoinfo
Args:
url (str): The mxc url of the video.
name (str): The filename of the video.
videoinfo (): Extra information about the video.
"""
return self.client.api.send_content(self.room_id, url, name, "m.video",
extra_information=videoinfo)
|
[
"def",
"send_video",
"(",
"self",
",",
"url",
",",
"name",
",",
"*",
"*",
"videoinfo",
")",
":",
"return",
"self",
".",
"client",
".",
"api",
".",
"send_content",
"(",
"self",
".",
"room_id",
",",
"url",
",",
"name",
",",
"\"m.video\"",
",",
"extra_information",
"=",
"videoinfo",
")"
] |
Send a pre-uploaded video to the room.
See http://matrix.org/docs/spec/client_server/r0.2.0.html#m-video
for videoinfo
Args:
url (str): The mxc url of the video.
name (str): The filename of the video.
videoinfo (): Extra information about the video.
|
[
"Send",
"a",
"pre",
"-",
"uploaded",
"video",
"to",
"the",
"room",
"."
] |
e734cce3ccd35f2d355c6a19a7a701033472498a
|
https://github.com/matrix-org/matrix-python-sdk/blob/e734cce3ccd35f2d355c6a19a7a701033472498a/matrix_client/room.py#L204-L216
|
233,916
|
matrix-org/matrix-python-sdk
|
matrix_client/room.py
|
Room.send_audio
|
def send_audio(self, url, name, **audioinfo):
"""Send a pre-uploaded audio to the room.
See http://matrix.org/docs/spec/client_server/r0.2.0.html#m-audio
for audioinfo
Args:
url (str): The mxc url of the audio.
name (str): The filename of the audio.
audioinfo (): Extra information about the audio.
"""
return self.client.api.send_content(self.room_id, url, name, "m.audio",
extra_information=audioinfo)
|
python
|
def send_audio(self, url, name, **audioinfo):
"""Send a pre-uploaded audio to the room.
See http://matrix.org/docs/spec/client_server/r0.2.0.html#m-audio
for audioinfo
Args:
url (str): The mxc url of the audio.
name (str): The filename of the audio.
audioinfo (): Extra information about the audio.
"""
return self.client.api.send_content(self.room_id, url, name, "m.audio",
extra_information=audioinfo)
|
[
"def",
"send_audio",
"(",
"self",
",",
"url",
",",
"name",
",",
"*",
"*",
"audioinfo",
")",
":",
"return",
"self",
".",
"client",
".",
"api",
".",
"send_content",
"(",
"self",
".",
"room_id",
",",
"url",
",",
"name",
",",
"\"m.audio\"",
",",
"extra_information",
"=",
"audioinfo",
")"
] |
Send a pre-uploaded audio to the room.
See http://matrix.org/docs/spec/client_server/r0.2.0.html#m-audio
for audioinfo
Args:
url (str): The mxc url of the audio.
name (str): The filename of the audio.
audioinfo (): Extra information about the audio.
|
[
"Send",
"a",
"pre",
"-",
"uploaded",
"audio",
"to",
"the",
"room",
"."
] |
e734cce3ccd35f2d355c6a19a7a701033472498a
|
https://github.com/matrix-org/matrix-python-sdk/blob/e734cce3ccd35f2d355c6a19a7a701033472498a/matrix_client/room.py#L218-L230
|
233,917
|
matrix-org/matrix-python-sdk
|
matrix_client/room.py
|
Room.redact_message
|
def redact_message(self, event_id, reason=None):
"""Redacts the message with specified event_id for the given reason.
See https://matrix.org/docs/spec/r0.0.1/client_server.html#id112
"""
return self.client.api.redact_event(self.room_id, event_id, reason)
|
python
|
def redact_message(self, event_id, reason=None):
"""Redacts the message with specified event_id for the given reason.
See https://matrix.org/docs/spec/r0.0.1/client_server.html#id112
"""
return self.client.api.redact_event(self.room_id, event_id, reason)
|
[
"def",
"redact_message",
"(",
"self",
",",
"event_id",
",",
"reason",
"=",
"None",
")",
":",
"return",
"self",
".",
"client",
".",
"api",
".",
"redact_event",
"(",
"self",
".",
"room_id",
",",
"event_id",
",",
"reason",
")"
] |
Redacts the message with specified event_id for the given reason.
See https://matrix.org/docs/spec/r0.0.1/client_server.html#id112
|
[
"Redacts",
"the",
"message",
"with",
"specified",
"event_id",
"for",
"the",
"given",
"reason",
"."
] |
e734cce3ccd35f2d355c6a19a7a701033472498a
|
https://github.com/matrix-org/matrix-python-sdk/blob/e734cce3ccd35f2d355c6a19a7a701033472498a/matrix_client/room.py#L232-L237
|
233,918
|
matrix-org/matrix-python-sdk
|
matrix_client/room.py
|
Room.add_listener
|
def add_listener(self, callback, event_type=None):
"""Add a callback handler for events going to this room.
Args:
callback (func(room, event)): Callback called when an event arrives.
event_type (str): The event_type to filter for.
Returns:
uuid.UUID: Unique id of the listener, can be used to identify the listener.
"""
listener_id = uuid4()
self.listeners.append(
{
'uid': listener_id,
'callback': callback,
'event_type': event_type
}
)
return listener_id
|
python
|
def add_listener(self, callback, event_type=None):
"""Add a callback handler for events going to this room.
Args:
callback (func(room, event)): Callback called when an event arrives.
event_type (str): The event_type to filter for.
Returns:
uuid.UUID: Unique id of the listener, can be used to identify the listener.
"""
listener_id = uuid4()
self.listeners.append(
{
'uid': listener_id,
'callback': callback,
'event_type': event_type
}
)
return listener_id
|
[
"def",
"add_listener",
"(",
"self",
",",
"callback",
",",
"event_type",
"=",
"None",
")",
":",
"listener_id",
"=",
"uuid4",
"(",
")",
"self",
".",
"listeners",
".",
"append",
"(",
"{",
"'uid'",
":",
"listener_id",
",",
"'callback'",
":",
"callback",
",",
"'event_type'",
":",
"event_type",
"}",
")",
"return",
"listener_id"
] |
Add a callback handler for events going to this room.
Args:
callback (func(room, event)): Callback called when an event arrives.
event_type (str): The event_type to filter for.
Returns:
uuid.UUID: Unique id of the listener, can be used to identify the listener.
|
[
"Add",
"a",
"callback",
"handler",
"for",
"events",
"going",
"to",
"this",
"room",
"."
] |
e734cce3ccd35f2d355c6a19a7a701033472498a
|
https://github.com/matrix-org/matrix-python-sdk/blob/e734cce3ccd35f2d355c6a19a7a701033472498a/matrix_client/room.py#L239-L256
|
233,919
|
matrix-org/matrix-python-sdk
|
matrix_client/room.py
|
Room.remove_listener
|
def remove_listener(self, uid):
"""Remove listener with given uid."""
self.listeners[:] = (listener for listener in self.listeners
if listener['uid'] != uid)
|
python
|
def remove_listener(self, uid):
"""Remove listener with given uid."""
self.listeners[:] = (listener for listener in self.listeners
if listener['uid'] != uid)
|
[
"def",
"remove_listener",
"(",
"self",
",",
"uid",
")",
":",
"self",
".",
"listeners",
"[",
":",
"]",
"=",
"(",
"listener",
"for",
"listener",
"in",
"self",
".",
"listeners",
"if",
"listener",
"[",
"'uid'",
"]",
"!=",
"uid",
")"
] |
Remove listener with given uid.
|
[
"Remove",
"listener",
"with",
"given",
"uid",
"."
] |
e734cce3ccd35f2d355c6a19a7a701033472498a
|
https://github.com/matrix-org/matrix-python-sdk/blob/e734cce3ccd35f2d355c6a19a7a701033472498a/matrix_client/room.py#L258-L261
|
233,920
|
matrix-org/matrix-python-sdk
|
matrix_client/room.py
|
Room.add_ephemeral_listener
|
def add_ephemeral_listener(self, callback, event_type=None):
"""Add a callback handler for ephemeral events going to this room.
Args:
callback (func(room, event)): Callback called when an ephemeral event arrives.
event_type (str): The event_type to filter for.
Returns:
uuid.UUID: Unique id of the listener, can be used to identify the listener.
"""
listener_id = uuid4()
self.ephemeral_listeners.append(
{
'uid': listener_id,
'callback': callback,
'event_type': event_type
}
)
return listener_id
|
python
|
def add_ephemeral_listener(self, callback, event_type=None):
"""Add a callback handler for ephemeral events going to this room.
Args:
callback (func(room, event)): Callback called when an ephemeral event arrives.
event_type (str): The event_type to filter for.
Returns:
uuid.UUID: Unique id of the listener, can be used to identify the listener.
"""
listener_id = uuid4()
self.ephemeral_listeners.append(
{
'uid': listener_id,
'callback': callback,
'event_type': event_type
}
)
return listener_id
|
[
"def",
"add_ephemeral_listener",
"(",
"self",
",",
"callback",
",",
"event_type",
"=",
"None",
")",
":",
"listener_id",
"=",
"uuid4",
"(",
")",
"self",
".",
"ephemeral_listeners",
".",
"append",
"(",
"{",
"'uid'",
":",
"listener_id",
",",
"'callback'",
":",
"callback",
",",
"'event_type'",
":",
"event_type",
"}",
")",
"return",
"listener_id"
] |
Add a callback handler for ephemeral events going to this room.
Args:
callback (func(room, event)): Callback called when an ephemeral event arrives.
event_type (str): The event_type to filter for.
Returns:
uuid.UUID: Unique id of the listener, can be used to identify the listener.
|
[
"Add",
"a",
"callback",
"handler",
"for",
"ephemeral",
"events",
"going",
"to",
"this",
"room",
"."
] |
e734cce3ccd35f2d355c6a19a7a701033472498a
|
https://github.com/matrix-org/matrix-python-sdk/blob/e734cce3ccd35f2d355c6a19a7a701033472498a/matrix_client/room.py#L263-L280
|
233,921
|
matrix-org/matrix-python-sdk
|
matrix_client/room.py
|
Room.remove_ephemeral_listener
|
def remove_ephemeral_listener(self, uid):
"""Remove ephemeral listener with given uid."""
self.ephemeral_listeners[:] = (listener for listener in self.ephemeral_listeners
if listener['uid'] != uid)
|
python
|
def remove_ephemeral_listener(self, uid):
"""Remove ephemeral listener with given uid."""
self.ephemeral_listeners[:] = (listener for listener in self.ephemeral_listeners
if listener['uid'] != uid)
|
[
"def",
"remove_ephemeral_listener",
"(",
"self",
",",
"uid",
")",
":",
"self",
".",
"ephemeral_listeners",
"[",
":",
"]",
"=",
"(",
"listener",
"for",
"listener",
"in",
"self",
".",
"ephemeral_listeners",
"if",
"listener",
"[",
"'uid'",
"]",
"!=",
"uid",
")"
] |
Remove ephemeral listener with given uid.
|
[
"Remove",
"ephemeral",
"listener",
"with",
"given",
"uid",
"."
] |
e734cce3ccd35f2d355c6a19a7a701033472498a
|
https://github.com/matrix-org/matrix-python-sdk/blob/e734cce3ccd35f2d355c6a19a7a701033472498a/matrix_client/room.py#L282-L285
|
233,922
|
matrix-org/matrix-python-sdk
|
matrix_client/room.py
|
Room.invite_user
|
def invite_user(self, user_id):
"""Invite a user to this room.
Returns:
boolean: Whether invitation was sent.
"""
try:
self.client.api.invite_user(self.room_id, user_id)
return True
except MatrixRequestError:
return False
|
python
|
def invite_user(self, user_id):
"""Invite a user to this room.
Returns:
boolean: Whether invitation was sent.
"""
try:
self.client.api.invite_user(self.room_id, user_id)
return True
except MatrixRequestError:
return False
|
[
"def",
"invite_user",
"(",
"self",
",",
"user_id",
")",
":",
"try",
":",
"self",
".",
"client",
".",
"api",
".",
"invite_user",
"(",
"self",
".",
"room_id",
",",
"user_id",
")",
"return",
"True",
"except",
"MatrixRequestError",
":",
"return",
"False"
] |
Invite a user to this room.
Returns:
boolean: Whether invitation was sent.
|
[
"Invite",
"a",
"user",
"to",
"this",
"room",
"."
] |
e734cce3ccd35f2d355c6a19a7a701033472498a
|
https://github.com/matrix-org/matrix-python-sdk/blob/e734cce3ccd35f2d355c6a19a7a701033472498a/matrix_client/room.py#L323-L333
|
233,923
|
matrix-org/matrix-python-sdk
|
matrix_client/room.py
|
Room.kick_user
|
def kick_user(self, user_id, reason=""):
"""Kick a user from this room.
Args:
user_id (str): The matrix user id of a user.
reason (str): A reason for kicking the user.
Returns:
boolean: Whether user was kicked.
"""
try:
self.client.api.kick_user(self.room_id, user_id)
return True
except MatrixRequestError:
return False
|
python
|
def kick_user(self, user_id, reason=""):
"""Kick a user from this room.
Args:
user_id (str): The matrix user id of a user.
reason (str): A reason for kicking the user.
Returns:
boolean: Whether user was kicked.
"""
try:
self.client.api.kick_user(self.room_id, user_id)
return True
except MatrixRequestError:
return False
|
[
"def",
"kick_user",
"(",
"self",
",",
"user_id",
",",
"reason",
"=",
"\"\"",
")",
":",
"try",
":",
"self",
".",
"client",
".",
"api",
".",
"kick_user",
"(",
"self",
".",
"room_id",
",",
"user_id",
")",
"return",
"True",
"except",
"MatrixRequestError",
":",
"return",
"False"
] |
Kick a user from this room.
Args:
user_id (str): The matrix user id of a user.
reason (str): A reason for kicking the user.
Returns:
boolean: Whether user was kicked.
|
[
"Kick",
"a",
"user",
"from",
"this",
"room",
"."
] |
e734cce3ccd35f2d355c6a19a7a701033472498a
|
https://github.com/matrix-org/matrix-python-sdk/blob/e734cce3ccd35f2d355c6a19a7a701033472498a/matrix_client/room.py#L335-L350
|
233,924
|
matrix-org/matrix-python-sdk
|
matrix_client/room.py
|
Room.leave
|
def leave(self):
"""Leave the room.
Returns:
boolean: Leaving the room was successful.
"""
try:
self.client.api.leave_room(self.room_id)
del self.client.rooms[self.room_id]
return True
except MatrixRequestError:
return False
|
python
|
def leave(self):
"""Leave the room.
Returns:
boolean: Leaving the room was successful.
"""
try:
self.client.api.leave_room(self.room_id)
del self.client.rooms[self.room_id]
return True
except MatrixRequestError:
return False
|
[
"def",
"leave",
"(",
"self",
")",
":",
"try",
":",
"self",
".",
"client",
".",
"api",
".",
"leave_room",
"(",
"self",
".",
"room_id",
")",
"del",
"self",
".",
"client",
".",
"rooms",
"[",
"self",
".",
"room_id",
"]",
"return",
"True",
"except",
"MatrixRequestError",
":",
"return",
"False"
] |
Leave the room.
Returns:
boolean: Leaving the room was successful.
|
[
"Leave",
"the",
"room",
"."
] |
e734cce3ccd35f2d355c6a19a7a701033472498a
|
https://github.com/matrix-org/matrix-python-sdk/blob/e734cce3ccd35f2d355c6a19a7a701033472498a/matrix_client/room.py#L380-L391
|
233,925
|
matrix-org/matrix-python-sdk
|
matrix_client/room.py
|
Room.update_room_name
|
def update_room_name(self):
"""Updates self.name and returns True if room name has changed."""
try:
response = self.client.api.get_room_name(self.room_id)
if "name" in response and response["name"] != self.name:
self.name = response["name"]
return True
else:
return False
except MatrixRequestError:
return False
|
python
|
def update_room_name(self):
"""Updates self.name and returns True if room name has changed."""
try:
response = self.client.api.get_room_name(self.room_id)
if "name" in response and response["name"] != self.name:
self.name = response["name"]
return True
else:
return False
except MatrixRequestError:
return False
|
[
"def",
"update_room_name",
"(",
"self",
")",
":",
"try",
":",
"response",
"=",
"self",
".",
"client",
".",
"api",
".",
"get_room_name",
"(",
"self",
".",
"room_id",
")",
"if",
"\"name\"",
"in",
"response",
"and",
"response",
"[",
"\"name\"",
"]",
"!=",
"self",
".",
"name",
":",
"self",
".",
"name",
"=",
"response",
"[",
"\"name\"",
"]",
"return",
"True",
"else",
":",
"return",
"False",
"except",
"MatrixRequestError",
":",
"return",
"False"
] |
Updates self.name and returns True if room name has changed.
|
[
"Updates",
"self",
".",
"name",
"and",
"returns",
"True",
"if",
"room",
"name",
"has",
"changed",
"."
] |
e734cce3ccd35f2d355c6a19a7a701033472498a
|
https://github.com/matrix-org/matrix-python-sdk/blob/e734cce3ccd35f2d355c6a19a7a701033472498a/matrix_client/room.py#L393-L403
|
233,926
|
matrix-org/matrix-python-sdk
|
matrix_client/room.py
|
Room.set_room_name
|
def set_room_name(self, name):
"""Return True if room name successfully changed."""
try:
self.client.api.set_room_name(self.room_id, name)
self.name = name
return True
except MatrixRequestError:
return False
|
python
|
def set_room_name(self, name):
"""Return True if room name successfully changed."""
try:
self.client.api.set_room_name(self.room_id, name)
self.name = name
return True
except MatrixRequestError:
return False
|
[
"def",
"set_room_name",
"(",
"self",
",",
"name",
")",
":",
"try",
":",
"self",
".",
"client",
".",
"api",
".",
"set_room_name",
"(",
"self",
".",
"room_id",
",",
"name",
")",
"self",
".",
"name",
"=",
"name",
"return",
"True",
"except",
"MatrixRequestError",
":",
"return",
"False"
] |
Return True if room name successfully changed.
|
[
"Return",
"True",
"if",
"room",
"name",
"successfully",
"changed",
"."
] |
e734cce3ccd35f2d355c6a19a7a701033472498a
|
https://github.com/matrix-org/matrix-python-sdk/blob/e734cce3ccd35f2d355c6a19a7a701033472498a/matrix_client/room.py#L405-L412
|
233,927
|
matrix-org/matrix-python-sdk
|
matrix_client/room.py
|
Room.send_state_event
|
def send_state_event(self, event_type, content, state_key=""):
"""Send a state event to the room.
Args:
event_type (str): The type of event that you are sending.
content (): An object with the content of the message.
state_key (str, optional): A unique key to identify the state.
"""
return self.client.api.send_state_event(
self.room_id,
event_type,
content,
state_key
)
|
python
|
def send_state_event(self, event_type, content, state_key=""):
"""Send a state event to the room.
Args:
event_type (str): The type of event that you are sending.
content (): An object with the content of the message.
state_key (str, optional): A unique key to identify the state.
"""
return self.client.api.send_state_event(
self.room_id,
event_type,
content,
state_key
)
|
[
"def",
"send_state_event",
"(",
"self",
",",
"event_type",
",",
"content",
",",
"state_key",
"=",
"\"\"",
")",
":",
"return",
"self",
".",
"client",
".",
"api",
".",
"send_state_event",
"(",
"self",
".",
"room_id",
",",
"event_type",
",",
"content",
",",
"state_key",
")"
] |
Send a state event to the room.
Args:
event_type (str): The type of event that you are sending.
content (): An object with the content of the message.
state_key (str, optional): A unique key to identify the state.
|
[
"Send",
"a",
"state",
"event",
"to",
"the",
"room",
"."
] |
e734cce3ccd35f2d355c6a19a7a701033472498a
|
https://github.com/matrix-org/matrix-python-sdk/blob/e734cce3ccd35f2d355c6a19a7a701033472498a/matrix_client/room.py#L414-L427
|
233,928
|
matrix-org/matrix-python-sdk
|
matrix_client/room.py
|
Room.update_room_topic
|
def update_room_topic(self):
"""Updates self.topic and returns True if room topic has changed."""
try:
response = self.client.api.get_room_topic(self.room_id)
if "topic" in response and response["topic"] != self.topic:
self.topic = response["topic"]
return True
else:
return False
except MatrixRequestError:
return False
|
python
|
def update_room_topic(self):
"""Updates self.topic and returns True if room topic has changed."""
try:
response = self.client.api.get_room_topic(self.room_id)
if "topic" in response and response["topic"] != self.topic:
self.topic = response["topic"]
return True
else:
return False
except MatrixRequestError:
return False
|
[
"def",
"update_room_topic",
"(",
"self",
")",
":",
"try",
":",
"response",
"=",
"self",
".",
"client",
".",
"api",
".",
"get_room_topic",
"(",
"self",
".",
"room_id",
")",
"if",
"\"topic\"",
"in",
"response",
"and",
"response",
"[",
"\"topic\"",
"]",
"!=",
"self",
".",
"topic",
":",
"self",
".",
"topic",
"=",
"response",
"[",
"\"topic\"",
"]",
"return",
"True",
"else",
":",
"return",
"False",
"except",
"MatrixRequestError",
":",
"return",
"False"
] |
Updates self.topic and returns True if room topic has changed.
|
[
"Updates",
"self",
".",
"topic",
"and",
"returns",
"True",
"if",
"room",
"topic",
"has",
"changed",
"."
] |
e734cce3ccd35f2d355c6a19a7a701033472498a
|
https://github.com/matrix-org/matrix-python-sdk/blob/e734cce3ccd35f2d355c6a19a7a701033472498a/matrix_client/room.py#L429-L439
|
233,929
|
matrix-org/matrix-python-sdk
|
matrix_client/room.py
|
Room.set_room_topic
|
def set_room_topic(self, topic):
"""Set room topic.
Returns:
boolean: True if the topic changed, False if not
"""
try:
self.client.api.set_room_topic(self.room_id, topic)
self.topic = topic
return True
except MatrixRequestError:
return False
|
python
|
def set_room_topic(self, topic):
"""Set room topic.
Returns:
boolean: True if the topic changed, False if not
"""
try:
self.client.api.set_room_topic(self.room_id, topic)
self.topic = topic
return True
except MatrixRequestError:
return False
|
[
"def",
"set_room_topic",
"(",
"self",
",",
"topic",
")",
":",
"try",
":",
"self",
".",
"client",
".",
"api",
".",
"set_room_topic",
"(",
"self",
".",
"room_id",
",",
"topic",
")",
"self",
".",
"topic",
"=",
"topic",
"return",
"True",
"except",
"MatrixRequestError",
":",
"return",
"False"
] |
Set room topic.
Returns:
boolean: True if the topic changed, False if not
|
[
"Set",
"room",
"topic",
"."
] |
e734cce3ccd35f2d355c6a19a7a701033472498a
|
https://github.com/matrix-org/matrix-python-sdk/blob/e734cce3ccd35f2d355c6a19a7a701033472498a/matrix_client/room.py#L441-L452
|
233,930
|
matrix-org/matrix-python-sdk
|
matrix_client/room.py
|
Room.update_aliases
|
def update_aliases(self):
"""Get aliases information from room state.
Returns:
boolean: True if the aliases changed, False if not
"""
try:
response = self.client.api.get_room_state(self.room_id)
for chunk in response:
if "content" in chunk and "aliases" in chunk["content"]:
if chunk["content"]["aliases"] != self.aliases:
self.aliases = chunk["content"]["aliases"]
return True
else:
return False
except MatrixRequestError:
return False
|
python
|
def update_aliases(self):
"""Get aliases information from room state.
Returns:
boolean: True if the aliases changed, False if not
"""
try:
response = self.client.api.get_room_state(self.room_id)
for chunk in response:
if "content" in chunk and "aliases" in chunk["content"]:
if chunk["content"]["aliases"] != self.aliases:
self.aliases = chunk["content"]["aliases"]
return True
else:
return False
except MatrixRequestError:
return False
|
[
"def",
"update_aliases",
"(",
"self",
")",
":",
"try",
":",
"response",
"=",
"self",
".",
"client",
".",
"api",
".",
"get_room_state",
"(",
"self",
".",
"room_id",
")",
"for",
"chunk",
"in",
"response",
":",
"if",
"\"content\"",
"in",
"chunk",
"and",
"\"aliases\"",
"in",
"chunk",
"[",
"\"content\"",
"]",
":",
"if",
"chunk",
"[",
"\"content\"",
"]",
"[",
"\"aliases\"",
"]",
"!=",
"self",
".",
"aliases",
":",
"self",
".",
"aliases",
"=",
"chunk",
"[",
"\"content\"",
"]",
"[",
"\"aliases\"",
"]",
"return",
"True",
"else",
":",
"return",
"False",
"except",
"MatrixRequestError",
":",
"return",
"False"
] |
Get aliases information from room state.
Returns:
boolean: True if the aliases changed, False if not
|
[
"Get",
"aliases",
"information",
"from",
"room",
"state",
"."
] |
e734cce3ccd35f2d355c6a19a7a701033472498a
|
https://github.com/matrix-org/matrix-python-sdk/blob/e734cce3ccd35f2d355c6a19a7a701033472498a/matrix_client/room.py#L454-L470
|
233,931
|
matrix-org/matrix-python-sdk
|
matrix_client/room.py
|
Room.add_room_alias
|
def add_room_alias(self, room_alias):
"""Add an alias to the room and return True if successful."""
try:
self.client.api.set_room_alias(self.room_id, room_alias)
return True
except MatrixRequestError:
return False
|
python
|
def add_room_alias(self, room_alias):
"""Add an alias to the room and return True if successful."""
try:
self.client.api.set_room_alias(self.room_id, room_alias)
return True
except MatrixRequestError:
return False
|
[
"def",
"add_room_alias",
"(",
"self",
",",
"room_alias",
")",
":",
"try",
":",
"self",
".",
"client",
".",
"api",
".",
"set_room_alias",
"(",
"self",
".",
"room_id",
",",
"room_alias",
")",
"return",
"True",
"except",
"MatrixRequestError",
":",
"return",
"False"
] |
Add an alias to the room and return True if successful.
|
[
"Add",
"an",
"alias",
"to",
"the",
"room",
"and",
"return",
"True",
"if",
"successful",
"."
] |
e734cce3ccd35f2d355c6a19a7a701033472498a
|
https://github.com/matrix-org/matrix-python-sdk/blob/e734cce3ccd35f2d355c6a19a7a701033472498a/matrix_client/room.py#L472-L478
|
233,932
|
matrix-org/matrix-python-sdk
|
matrix_client/room.py
|
Room.backfill_previous_messages
|
def backfill_previous_messages(self, reverse=False, limit=10):
"""Backfill handling of previous messages.
Args:
reverse (bool): When false messages will be backfilled in their original
order (old to new), otherwise the order will be reversed (new to old).
limit (int): Number of messages to go back.
"""
res = self.client.api.get_room_messages(self.room_id, self.prev_batch,
direction="b", limit=limit)
events = res["chunk"]
if not reverse:
events = reversed(events)
for event in events:
self._put_event(event)
|
python
|
def backfill_previous_messages(self, reverse=False, limit=10):
"""Backfill handling of previous messages.
Args:
reverse (bool): When false messages will be backfilled in their original
order (old to new), otherwise the order will be reversed (new to old).
limit (int): Number of messages to go back.
"""
res = self.client.api.get_room_messages(self.room_id, self.prev_batch,
direction="b", limit=limit)
events = res["chunk"]
if not reverse:
events = reversed(events)
for event in events:
self._put_event(event)
|
[
"def",
"backfill_previous_messages",
"(",
"self",
",",
"reverse",
"=",
"False",
",",
"limit",
"=",
"10",
")",
":",
"res",
"=",
"self",
".",
"client",
".",
"api",
".",
"get_room_messages",
"(",
"self",
".",
"room_id",
",",
"self",
".",
"prev_batch",
",",
"direction",
"=",
"\"b\"",
",",
"limit",
"=",
"limit",
")",
"events",
"=",
"res",
"[",
"\"chunk\"",
"]",
"if",
"not",
"reverse",
":",
"events",
"=",
"reversed",
"(",
"events",
")",
"for",
"event",
"in",
"events",
":",
"self",
".",
"_put_event",
"(",
"event",
")"
] |
Backfill handling of previous messages.
Args:
reverse (bool): When false messages will be backfilled in their original
order (old to new), otherwise the order will be reversed (new to old).
limit (int): Number of messages to go back.
|
[
"Backfill",
"handling",
"of",
"previous",
"messages",
"."
] |
e734cce3ccd35f2d355c6a19a7a701033472498a
|
https://github.com/matrix-org/matrix-python-sdk/blob/e734cce3ccd35f2d355c6a19a7a701033472498a/matrix_client/room.py#L502-L516
|
233,933
|
matrix-org/matrix-python-sdk
|
matrix_client/room.py
|
Room.modify_user_power_levels
|
def modify_user_power_levels(self, users=None, users_default=None):
"""Modify the power level for a subset of users
Args:
users(dict): Power levels to assign to specific users, in the form
{"@name0:host0": 10, "@name1:host1": 100, "@name3:host3", None}
A level of None causes the user to revert to the default level
as specified by users_default.
users_default(int): Default power level for users in the room
Returns:
True if successful, False if not
"""
try:
content = self.client.api.get_power_levels(self.room_id)
if users_default:
content["users_default"] = users_default
if users:
if "users" in content:
content["users"].update(users)
else:
content["users"] = users
# Remove any keys with value None
for user, power_level in list(content["users"].items()):
if power_level is None:
del content["users"][user]
self.client.api.set_power_levels(self.room_id, content)
return True
except MatrixRequestError:
return False
|
python
|
def modify_user_power_levels(self, users=None, users_default=None):
"""Modify the power level for a subset of users
Args:
users(dict): Power levels to assign to specific users, in the form
{"@name0:host0": 10, "@name1:host1": 100, "@name3:host3", None}
A level of None causes the user to revert to the default level
as specified by users_default.
users_default(int): Default power level for users in the room
Returns:
True if successful, False if not
"""
try:
content = self.client.api.get_power_levels(self.room_id)
if users_default:
content["users_default"] = users_default
if users:
if "users" in content:
content["users"].update(users)
else:
content["users"] = users
# Remove any keys with value None
for user, power_level in list(content["users"].items()):
if power_level is None:
del content["users"][user]
self.client.api.set_power_levels(self.room_id, content)
return True
except MatrixRequestError:
return False
|
[
"def",
"modify_user_power_levels",
"(",
"self",
",",
"users",
"=",
"None",
",",
"users_default",
"=",
"None",
")",
":",
"try",
":",
"content",
"=",
"self",
".",
"client",
".",
"api",
".",
"get_power_levels",
"(",
"self",
".",
"room_id",
")",
"if",
"users_default",
":",
"content",
"[",
"\"users_default\"",
"]",
"=",
"users_default",
"if",
"users",
":",
"if",
"\"users\"",
"in",
"content",
":",
"content",
"[",
"\"users\"",
"]",
".",
"update",
"(",
"users",
")",
"else",
":",
"content",
"[",
"\"users\"",
"]",
"=",
"users",
"# Remove any keys with value None",
"for",
"user",
",",
"power_level",
"in",
"list",
"(",
"content",
"[",
"\"users\"",
"]",
".",
"items",
"(",
")",
")",
":",
"if",
"power_level",
"is",
"None",
":",
"del",
"content",
"[",
"\"users\"",
"]",
"[",
"user",
"]",
"self",
".",
"client",
".",
"api",
".",
"set_power_levels",
"(",
"self",
".",
"room_id",
",",
"content",
")",
"return",
"True",
"except",
"MatrixRequestError",
":",
"return",
"False"
] |
Modify the power level for a subset of users
Args:
users(dict): Power levels to assign to specific users, in the form
{"@name0:host0": 10, "@name1:host1": 100, "@name3:host3", None}
A level of None causes the user to revert to the default level
as specified by users_default.
users_default(int): Default power level for users in the room
Returns:
True if successful, False if not
|
[
"Modify",
"the",
"power",
"level",
"for",
"a",
"subset",
"of",
"users"
] |
e734cce3ccd35f2d355c6a19a7a701033472498a
|
https://github.com/matrix-org/matrix-python-sdk/blob/e734cce3ccd35f2d355c6a19a7a701033472498a/matrix_client/room.py#L518-L549
|
233,934
|
matrix-org/matrix-python-sdk
|
matrix_client/room.py
|
Room.modify_required_power_levels
|
def modify_required_power_levels(self, events=None, **kwargs):
"""Modifies room power level requirements.
Args:
events(dict): Power levels required for sending specific event types,
in the form {"m.room.whatever0": 60, "m.room.whatever2": None}.
Overrides events_default and state_default for the specified
events. A level of None causes the target event to revert to the
default level as specified by events_default or state_default.
**kwargs: Key/value pairs specifying the power levels required for
various actions:
- events_default(int): Default level for sending message events
- state_default(int): Default level for sending state events
- invite(int): Inviting a user
- redact(int): Redacting an event
- ban(int): Banning a user
- kick(int): Kicking a user
Returns:
True if successful, False if not
"""
try:
content = self.client.api.get_power_levels(self.room_id)
content.update(kwargs)
for key, value in list(content.items()):
if value is None:
del content[key]
if events:
if "events" in content:
content["events"].update(events)
else:
content["events"] = events
# Remove any keys with value None
for event, power_level in list(content["events"].items()):
if power_level is None:
del content["events"][event]
self.client.api.set_power_levels(self.room_id, content)
return True
except MatrixRequestError:
return False
|
python
|
def modify_required_power_levels(self, events=None, **kwargs):
"""Modifies room power level requirements.
Args:
events(dict): Power levels required for sending specific event types,
in the form {"m.room.whatever0": 60, "m.room.whatever2": None}.
Overrides events_default and state_default for the specified
events. A level of None causes the target event to revert to the
default level as specified by events_default or state_default.
**kwargs: Key/value pairs specifying the power levels required for
various actions:
- events_default(int): Default level for sending message events
- state_default(int): Default level for sending state events
- invite(int): Inviting a user
- redact(int): Redacting an event
- ban(int): Banning a user
- kick(int): Kicking a user
Returns:
True if successful, False if not
"""
try:
content = self.client.api.get_power_levels(self.room_id)
content.update(kwargs)
for key, value in list(content.items()):
if value is None:
del content[key]
if events:
if "events" in content:
content["events"].update(events)
else:
content["events"] = events
# Remove any keys with value None
for event, power_level in list(content["events"].items()):
if power_level is None:
del content["events"][event]
self.client.api.set_power_levels(self.room_id, content)
return True
except MatrixRequestError:
return False
|
[
"def",
"modify_required_power_levels",
"(",
"self",
",",
"events",
"=",
"None",
",",
"*",
"*",
"kwargs",
")",
":",
"try",
":",
"content",
"=",
"self",
".",
"client",
".",
"api",
".",
"get_power_levels",
"(",
"self",
".",
"room_id",
")",
"content",
".",
"update",
"(",
"kwargs",
")",
"for",
"key",
",",
"value",
"in",
"list",
"(",
"content",
".",
"items",
"(",
")",
")",
":",
"if",
"value",
"is",
"None",
":",
"del",
"content",
"[",
"key",
"]",
"if",
"events",
":",
"if",
"\"events\"",
"in",
"content",
":",
"content",
"[",
"\"events\"",
"]",
".",
"update",
"(",
"events",
")",
"else",
":",
"content",
"[",
"\"events\"",
"]",
"=",
"events",
"# Remove any keys with value None",
"for",
"event",
",",
"power_level",
"in",
"list",
"(",
"content",
"[",
"\"events\"",
"]",
".",
"items",
"(",
")",
")",
":",
"if",
"power_level",
"is",
"None",
":",
"del",
"content",
"[",
"\"events\"",
"]",
"[",
"event",
"]",
"self",
".",
"client",
".",
"api",
".",
"set_power_levels",
"(",
"self",
".",
"room_id",
",",
"content",
")",
"return",
"True",
"except",
"MatrixRequestError",
":",
"return",
"False"
] |
Modifies room power level requirements.
Args:
events(dict): Power levels required for sending specific event types,
in the form {"m.room.whatever0": 60, "m.room.whatever2": None}.
Overrides events_default and state_default for the specified
events. A level of None causes the target event to revert to the
default level as specified by events_default or state_default.
**kwargs: Key/value pairs specifying the power levels required for
various actions:
- events_default(int): Default level for sending message events
- state_default(int): Default level for sending state events
- invite(int): Inviting a user
- redact(int): Redacting an event
- ban(int): Banning a user
- kick(int): Kicking a user
Returns:
True if successful, False if not
|
[
"Modifies",
"room",
"power",
"level",
"requirements",
"."
] |
e734cce3ccd35f2d355c6a19a7a701033472498a
|
https://github.com/matrix-org/matrix-python-sdk/blob/e734cce3ccd35f2d355c6a19a7a701033472498a/matrix_client/room.py#L551-L594
|
233,935
|
matrix-org/matrix-python-sdk
|
matrix_client/room.py
|
Room.set_invite_only
|
def set_invite_only(self, invite_only):
"""Set how the room can be joined.
Args:
invite_only(bool): If True, users will have to be invited to join
the room. If False, anyone who knows the room link can join.
Returns:
True if successful, False if not
"""
join_rule = "invite" if invite_only else "public"
try:
self.client.api.set_join_rule(self.room_id, join_rule)
self.invite_only = invite_only
return True
except MatrixRequestError:
return False
|
python
|
def set_invite_only(self, invite_only):
"""Set how the room can be joined.
Args:
invite_only(bool): If True, users will have to be invited to join
the room. If False, anyone who knows the room link can join.
Returns:
True if successful, False if not
"""
join_rule = "invite" if invite_only else "public"
try:
self.client.api.set_join_rule(self.room_id, join_rule)
self.invite_only = invite_only
return True
except MatrixRequestError:
return False
|
[
"def",
"set_invite_only",
"(",
"self",
",",
"invite_only",
")",
":",
"join_rule",
"=",
"\"invite\"",
"if",
"invite_only",
"else",
"\"public\"",
"try",
":",
"self",
".",
"client",
".",
"api",
".",
"set_join_rule",
"(",
"self",
".",
"room_id",
",",
"join_rule",
")",
"self",
".",
"invite_only",
"=",
"invite_only",
"return",
"True",
"except",
"MatrixRequestError",
":",
"return",
"False"
] |
Set how the room can be joined.
Args:
invite_only(bool): If True, users will have to be invited to join
the room. If False, anyone who knows the room link can join.
Returns:
True if successful, False if not
|
[
"Set",
"how",
"the",
"room",
"can",
"be",
"joined",
"."
] |
e734cce3ccd35f2d355c6a19a7a701033472498a
|
https://github.com/matrix-org/matrix-python-sdk/blob/e734cce3ccd35f2d355c6a19a7a701033472498a/matrix_client/room.py#L596-L612
|
233,936
|
matrix-org/matrix-python-sdk
|
matrix_client/room.py
|
Room.set_guest_access
|
def set_guest_access(self, allow_guests):
"""Set whether guests can join the room and return True if successful."""
guest_access = "can_join" if allow_guests else "forbidden"
try:
self.client.api.set_guest_access(self.room_id, guest_access)
self.guest_access = allow_guests
return True
except MatrixRequestError:
return False
|
python
|
def set_guest_access(self, allow_guests):
"""Set whether guests can join the room and return True if successful."""
guest_access = "can_join" if allow_guests else "forbidden"
try:
self.client.api.set_guest_access(self.room_id, guest_access)
self.guest_access = allow_guests
return True
except MatrixRequestError:
return False
|
[
"def",
"set_guest_access",
"(",
"self",
",",
"allow_guests",
")",
":",
"guest_access",
"=",
"\"can_join\"",
"if",
"allow_guests",
"else",
"\"forbidden\"",
"try",
":",
"self",
".",
"client",
".",
"api",
".",
"set_guest_access",
"(",
"self",
".",
"room_id",
",",
"guest_access",
")",
"self",
".",
"guest_access",
"=",
"allow_guests",
"return",
"True",
"except",
"MatrixRequestError",
":",
"return",
"False"
] |
Set whether guests can join the room and return True if successful.
|
[
"Set",
"whether",
"guests",
"can",
"join",
"the",
"room",
"and",
"return",
"True",
"if",
"successful",
"."
] |
e734cce3ccd35f2d355c6a19a7a701033472498a
|
https://github.com/matrix-org/matrix-python-sdk/blob/e734cce3ccd35f2d355c6a19a7a701033472498a/matrix_client/room.py#L614-L622
|
233,937
|
matrix-org/matrix-python-sdk
|
matrix_client/room.py
|
Room.enable_encryption
|
def enable_encryption(self):
"""Enables encryption in the room.
NOTE: Once enabled, encryption cannot be disabled.
Returns:
True if successful, False if not
"""
try:
self.send_state_event("m.room.encryption",
{"algorithm": "m.megolm.v1.aes-sha2"})
self.encrypted = True
return True
except MatrixRequestError:
return False
|
python
|
def enable_encryption(self):
"""Enables encryption in the room.
NOTE: Once enabled, encryption cannot be disabled.
Returns:
True if successful, False if not
"""
try:
self.send_state_event("m.room.encryption",
{"algorithm": "m.megolm.v1.aes-sha2"})
self.encrypted = True
return True
except MatrixRequestError:
return False
|
[
"def",
"enable_encryption",
"(",
"self",
")",
":",
"try",
":",
"self",
".",
"send_state_event",
"(",
"\"m.room.encryption\"",
",",
"{",
"\"algorithm\"",
":",
"\"m.megolm.v1.aes-sha2\"",
"}",
")",
"self",
".",
"encrypted",
"=",
"True",
"return",
"True",
"except",
"MatrixRequestError",
":",
"return",
"False"
] |
Enables encryption in the room.
NOTE: Once enabled, encryption cannot be disabled.
Returns:
True if successful, False if not
|
[
"Enables",
"encryption",
"in",
"the",
"room",
"."
] |
e734cce3ccd35f2d355c6a19a7a701033472498a
|
https://github.com/matrix-org/matrix-python-sdk/blob/e734cce3ccd35f2d355c6a19a7a701033472498a/matrix_client/room.py#L624-L638
|
233,938
|
matrix-org/matrix-python-sdk
|
samples/UserPassOrTokenClient.py
|
example
|
def example(host, user, password, token):
"""run the example."""
client = None
try:
if token:
print('token login')
client = MatrixClient(host, token=token, user_id=user)
else:
print('password login')
client = MatrixClient(host)
token = client.login_with_password(user, password)
print('got token: %s' % token)
except MatrixRequestError as e:
print(e)
if e.code == 403:
print("Bad username or password")
exit(2)
elif e.code == 401:
print("Bad username or token")
exit(3)
else:
print("Verify server details.")
exit(4)
except MissingSchema as e:
print(e)
print("Bad formatting of URL.")
exit(5)
except InvalidSchema as e:
print(e)
print("Invalid URL schema")
exit(6)
print("is in rooms")
for room_id, room in client.get_rooms().items():
print(room_id)
|
python
|
def example(host, user, password, token):
"""run the example."""
client = None
try:
if token:
print('token login')
client = MatrixClient(host, token=token, user_id=user)
else:
print('password login')
client = MatrixClient(host)
token = client.login_with_password(user, password)
print('got token: %s' % token)
except MatrixRequestError as e:
print(e)
if e.code == 403:
print("Bad username or password")
exit(2)
elif e.code == 401:
print("Bad username or token")
exit(3)
else:
print("Verify server details.")
exit(4)
except MissingSchema as e:
print(e)
print("Bad formatting of URL.")
exit(5)
except InvalidSchema as e:
print(e)
print("Invalid URL schema")
exit(6)
print("is in rooms")
for room_id, room in client.get_rooms().items():
print(room_id)
|
[
"def",
"example",
"(",
"host",
",",
"user",
",",
"password",
",",
"token",
")",
":",
"client",
"=",
"None",
"try",
":",
"if",
"token",
":",
"print",
"(",
"'token login'",
")",
"client",
"=",
"MatrixClient",
"(",
"host",
",",
"token",
"=",
"token",
",",
"user_id",
"=",
"user",
")",
"else",
":",
"print",
"(",
"'password login'",
")",
"client",
"=",
"MatrixClient",
"(",
"host",
")",
"token",
"=",
"client",
".",
"login_with_password",
"(",
"user",
",",
"password",
")",
"print",
"(",
"'got token: %s'",
"%",
"token",
")",
"except",
"MatrixRequestError",
"as",
"e",
":",
"print",
"(",
"e",
")",
"if",
"e",
".",
"code",
"==",
"403",
":",
"print",
"(",
"\"Bad username or password\"",
")",
"exit",
"(",
"2",
")",
"elif",
"e",
".",
"code",
"==",
"401",
":",
"print",
"(",
"\"Bad username or token\"",
")",
"exit",
"(",
"3",
")",
"else",
":",
"print",
"(",
"\"Verify server details.\"",
")",
"exit",
"(",
"4",
")",
"except",
"MissingSchema",
"as",
"e",
":",
"print",
"(",
"e",
")",
"print",
"(",
"\"Bad formatting of URL.\"",
")",
"exit",
"(",
"5",
")",
"except",
"InvalidSchema",
"as",
"e",
":",
"print",
"(",
"e",
")",
"print",
"(",
"\"Invalid URL schema\"",
")",
"exit",
"(",
"6",
")",
"print",
"(",
"\"is in rooms\"",
")",
"for",
"room_id",
",",
"room",
"in",
"client",
".",
"get_rooms",
"(",
")",
".",
"items",
"(",
")",
":",
"print",
"(",
"room_id",
")"
] |
run the example.
|
[
"run",
"the",
"example",
"."
] |
e734cce3ccd35f2d355c6a19a7a701033472498a
|
https://github.com/matrix-org/matrix-python-sdk/blob/e734cce3ccd35f2d355c6a19a7a701033472498a/samples/UserPassOrTokenClient.py#L24-L57
|
233,939
|
matrix-org/matrix-python-sdk
|
samples/UserPassOrTokenClient.py
|
main
|
def main():
"""Main entry."""
parser = argparse.ArgumentParser()
parser.add_argument("--host", type=str, required=True)
parser.add_argument("--user", type=str, required=True)
parser.add_argument("--password", type=str)
parser.add_argument("--token", type=str)
args = parser.parse_args()
if not args.password and not args.token:
print('password or token is required')
exit(1)
example(args.host, args.user, args.password, args.token)
|
python
|
def main():
"""Main entry."""
parser = argparse.ArgumentParser()
parser.add_argument("--host", type=str, required=True)
parser.add_argument("--user", type=str, required=True)
parser.add_argument("--password", type=str)
parser.add_argument("--token", type=str)
args = parser.parse_args()
if not args.password and not args.token:
print('password or token is required')
exit(1)
example(args.host, args.user, args.password, args.token)
|
[
"def",
"main",
"(",
")",
":",
"parser",
"=",
"argparse",
".",
"ArgumentParser",
"(",
")",
"parser",
".",
"add_argument",
"(",
"\"--host\"",
",",
"type",
"=",
"str",
",",
"required",
"=",
"True",
")",
"parser",
".",
"add_argument",
"(",
"\"--user\"",
",",
"type",
"=",
"str",
",",
"required",
"=",
"True",
")",
"parser",
".",
"add_argument",
"(",
"\"--password\"",
",",
"type",
"=",
"str",
")",
"parser",
".",
"add_argument",
"(",
"\"--token\"",
",",
"type",
"=",
"str",
")",
"args",
"=",
"parser",
".",
"parse_args",
"(",
")",
"if",
"not",
"args",
".",
"password",
"and",
"not",
"args",
".",
"token",
":",
"print",
"(",
"'password or token is required'",
")",
"exit",
"(",
"1",
")",
"example",
"(",
"args",
".",
"host",
",",
"args",
".",
"user",
",",
"args",
".",
"password",
",",
"args",
".",
"token",
")"
] |
Main entry.
|
[
"Main",
"entry",
"."
] |
e734cce3ccd35f2d355c6a19a7a701033472498a
|
https://github.com/matrix-org/matrix-python-sdk/blob/e734cce3ccd35f2d355c6a19a7a701033472498a/samples/UserPassOrTokenClient.py#L60-L71
|
233,940
|
matrix-org/matrix-python-sdk
|
matrix_client/api.py
|
MatrixHttpApi.sync
|
def sync(self, since=None, timeout_ms=30000, filter=None,
full_state=None, set_presence=None):
""" Perform a sync request.
Args:
since (str): Optional. A token which specifies where to continue a sync from.
timeout_ms (int): Optional. The time in milliseconds to wait.
filter (int|str): Either a Filter ID or a JSON string.
full_state (bool): Return the full state for every room the user has joined
Defaults to false.
set_presence (str): Should the client be marked as "online" or" offline"
"""
request = {
# non-integer timeouts appear to cause issues
"timeout": int(timeout_ms)
}
if since:
request["since"] = since
if filter:
request["filter"] = filter
if full_state:
request["full_state"] = json.dumps(full_state)
if set_presence:
request["set_presence"] = set_presence
return self._send("GET", "/sync", query_params=request,
api_path=MATRIX_V2_API_PATH)
|
python
|
def sync(self, since=None, timeout_ms=30000, filter=None,
full_state=None, set_presence=None):
""" Perform a sync request.
Args:
since (str): Optional. A token which specifies where to continue a sync from.
timeout_ms (int): Optional. The time in milliseconds to wait.
filter (int|str): Either a Filter ID or a JSON string.
full_state (bool): Return the full state for every room the user has joined
Defaults to false.
set_presence (str): Should the client be marked as "online" or" offline"
"""
request = {
# non-integer timeouts appear to cause issues
"timeout": int(timeout_ms)
}
if since:
request["since"] = since
if filter:
request["filter"] = filter
if full_state:
request["full_state"] = json.dumps(full_state)
if set_presence:
request["set_presence"] = set_presence
return self._send("GET", "/sync", query_params=request,
api_path=MATRIX_V2_API_PATH)
|
[
"def",
"sync",
"(",
"self",
",",
"since",
"=",
"None",
",",
"timeout_ms",
"=",
"30000",
",",
"filter",
"=",
"None",
",",
"full_state",
"=",
"None",
",",
"set_presence",
"=",
"None",
")",
":",
"request",
"=",
"{",
"# non-integer timeouts appear to cause issues",
"\"timeout\"",
":",
"int",
"(",
"timeout_ms",
")",
"}",
"if",
"since",
":",
"request",
"[",
"\"since\"",
"]",
"=",
"since",
"if",
"filter",
":",
"request",
"[",
"\"filter\"",
"]",
"=",
"filter",
"if",
"full_state",
":",
"request",
"[",
"\"full_state\"",
"]",
"=",
"json",
".",
"dumps",
"(",
"full_state",
")",
"if",
"set_presence",
":",
"request",
"[",
"\"set_presence\"",
"]",
"=",
"set_presence",
"return",
"self",
".",
"_send",
"(",
"\"GET\"",
",",
"\"/sync\"",
",",
"query_params",
"=",
"request",
",",
"api_path",
"=",
"MATRIX_V2_API_PATH",
")"
] |
Perform a sync request.
Args:
since (str): Optional. A token which specifies where to continue a sync from.
timeout_ms (int): Optional. The time in milliseconds to wait.
filter (int|str): Either a Filter ID or a JSON string.
full_state (bool): Return the full state for every room the user has joined
Defaults to false.
set_presence (str): Should the client be marked as "online" or" offline"
|
[
"Perform",
"a",
"sync",
"request",
"."
] |
e734cce3ccd35f2d355c6a19a7a701033472498a
|
https://github.com/matrix-org/matrix-python-sdk/blob/e734cce3ccd35f2d355c6a19a7a701033472498a/matrix_client/api.py#L92-L123
|
233,941
|
matrix-org/matrix-python-sdk
|
matrix_client/api.py
|
MatrixHttpApi.send_location
|
def send_location(self, room_id, geo_uri, name, thumb_url=None, thumb_info=None,
timestamp=None):
"""Send m.location message event
Args:
room_id (str): The room ID to send the event in.
geo_uri (str): The geo uri representing the location.
name (str): Description for the location.
thumb_url (str): URL to the thumbnail of the location.
thumb_info (dict): Metadata about the thumbnail, type ImageInfo.
timestamp (int): Set origin_server_ts (For application services only)
"""
content_pack = {
"geo_uri": geo_uri,
"msgtype": "m.location",
"body": name,
}
if thumb_url:
content_pack["thumbnail_url"] = thumb_url
if thumb_info:
content_pack["thumbnail_info"] = thumb_info
return self.send_message_event(room_id, "m.room.message", content_pack,
timestamp=timestamp)
|
python
|
def send_location(self, room_id, geo_uri, name, thumb_url=None, thumb_info=None,
timestamp=None):
"""Send m.location message event
Args:
room_id (str): The room ID to send the event in.
geo_uri (str): The geo uri representing the location.
name (str): Description for the location.
thumb_url (str): URL to the thumbnail of the location.
thumb_info (dict): Metadata about the thumbnail, type ImageInfo.
timestamp (int): Set origin_server_ts (For application services only)
"""
content_pack = {
"geo_uri": geo_uri,
"msgtype": "m.location",
"body": name,
}
if thumb_url:
content_pack["thumbnail_url"] = thumb_url
if thumb_info:
content_pack["thumbnail_info"] = thumb_info
return self.send_message_event(room_id, "m.room.message", content_pack,
timestamp=timestamp)
|
[
"def",
"send_location",
"(",
"self",
",",
"room_id",
",",
"geo_uri",
",",
"name",
",",
"thumb_url",
"=",
"None",
",",
"thumb_info",
"=",
"None",
",",
"timestamp",
"=",
"None",
")",
":",
"content_pack",
"=",
"{",
"\"geo_uri\"",
":",
"geo_uri",
",",
"\"msgtype\"",
":",
"\"m.location\"",
",",
"\"body\"",
":",
"name",
",",
"}",
"if",
"thumb_url",
":",
"content_pack",
"[",
"\"thumbnail_url\"",
"]",
"=",
"thumb_url",
"if",
"thumb_info",
":",
"content_pack",
"[",
"\"thumbnail_info\"",
"]",
"=",
"thumb_info",
"return",
"self",
".",
"send_message_event",
"(",
"room_id",
",",
"\"m.room.message\"",
",",
"content_pack",
",",
"timestamp",
"=",
"timestamp",
")"
] |
Send m.location message event
Args:
room_id (str): The room ID to send the event in.
geo_uri (str): The geo uri representing the location.
name (str): Description for the location.
thumb_url (str): URL to the thumbnail of the location.
thumb_info (dict): Metadata about the thumbnail, type ImageInfo.
timestamp (int): Set origin_server_ts (For application services only)
|
[
"Send",
"m",
".",
"location",
"message",
"event"
] |
e734cce3ccd35f2d355c6a19a7a701033472498a
|
https://github.com/matrix-org/matrix-python-sdk/blob/e734cce3ccd35f2d355c6a19a7a701033472498a/matrix_client/api.py#L351-L374
|
233,942
|
matrix-org/matrix-python-sdk
|
matrix_client/api.py
|
MatrixHttpApi.kick_user
|
def kick_user(self, room_id, user_id, reason=""):
"""Calls set_membership with membership="leave" for the user_id provided
"""
self.set_membership(room_id, user_id, "leave", reason)
|
python
|
def kick_user(self, room_id, user_id, reason=""):
"""Calls set_membership with membership="leave" for the user_id provided
"""
self.set_membership(room_id, user_id, "leave", reason)
|
[
"def",
"kick_user",
"(",
"self",
",",
"room_id",
",",
"user_id",
",",
"reason",
"=",
"\"\"",
")",
":",
"self",
".",
"set_membership",
"(",
"room_id",
",",
"user_id",
",",
"\"leave\"",
",",
"reason",
")"
] |
Calls set_membership with membership="leave" for the user_id provided
|
[
"Calls",
"set_membership",
"with",
"membership",
"=",
"leave",
"for",
"the",
"user_id",
"provided"
] |
e734cce3ccd35f2d355c6a19a7a701033472498a
|
https://github.com/matrix-org/matrix-python-sdk/blob/e734cce3ccd35f2d355c6a19a7a701033472498a/matrix_client/api.py#L555-L558
|
233,943
|
matrix-org/matrix-python-sdk
|
matrix_client/api.py
|
MatrixHttpApi.media_download
|
def media_download(self, mxcurl, allow_remote=True):
"""Download raw media from provided mxc URL.
Args:
mxcurl (str): mxc media URL.
allow_remote (bool): indicates to the server that it should not
attempt to fetch the media if it is deemed remote. Defaults
to true if not provided.
"""
query_params = {}
if not allow_remote:
query_params["allow_remote"] = False
if mxcurl.startswith('mxc://'):
return self._send(
"GET", mxcurl[6:],
api_path="/_matrix/media/r0/download/",
query_params=query_params,
return_json=False
)
else:
raise ValueError(
"MXC URL '%s' did not begin with 'mxc://'" % mxcurl
)
|
python
|
def media_download(self, mxcurl, allow_remote=True):
"""Download raw media from provided mxc URL.
Args:
mxcurl (str): mxc media URL.
allow_remote (bool): indicates to the server that it should not
attempt to fetch the media if it is deemed remote. Defaults
to true if not provided.
"""
query_params = {}
if not allow_remote:
query_params["allow_remote"] = False
if mxcurl.startswith('mxc://'):
return self._send(
"GET", mxcurl[6:],
api_path="/_matrix/media/r0/download/",
query_params=query_params,
return_json=False
)
else:
raise ValueError(
"MXC URL '%s' did not begin with 'mxc://'" % mxcurl
)
|
[
"def",
"media_download",
"(",
"self",
",",
"mxcurl",
",",
"allow_remote",
"=",
"True",
")",
":",
"query_params",
"=",
"{",
"}",
"if",
"not",
"allow_remote",
":",
"query_params",
"[",
"\"allow_remote\"",
"]",
"=",
"False",
"if",
"mxcurl",
".",
"startswith",
"(",
"'mxc://'",
")",
":",
"return",
"self",
".",
"_send",
"(",
"\"GET\"",
",",
"mxcurl",
"[",
"6",
":",
"]",
",",
"api_path",
"=",
"\"/_matrix/media/r0/download/\"",
",",
"query_params",
"=",
"query_params",
",",
"return_json",
"=",
"False",
")",
"else",
":",
"raise",
"ValueError",
"(",
"\"MXC URL '%s' did not begin with 'mxc://'\"",
"%",
"mxcurl",
")"
] |
Download raw media from provided mxc URL.
Args:
mxcurl (str): mxc media URL.
allow_remote (bool): indicates to the server that it should not
attempt to fetch the media if it is deemed remote. Defaults
to true if not provided.
|
[
"Download",
"raw",
"media",
"from",
"provided",
"mxc",
"URL",
"."
] |
e734cce3ccd35f2d355c6a19a7a701033472498a
|
https://github.com/matrix-org/matrix-python-sdk/blob/e734cce3ccd35f2d355c6a19a7a701033472498a/matrix_client/api.py#L791-L813
|
233,944
|
matrix-org/matrix-python-sdk
|
matrix_client/api.py
|
MatrixHttpApi.get_thumbnail
|
def get_thumbnail(self, mxcurl, width, height, method='scale', allow_remote=True):
"""Download raw media thumbnail from provided mxc URL.
Args:
mxcurl (str): mxc media URL
width (int): desired thumbnail width
height (int): desired thumbnail height
method (str): thumb creation method. Must be
in ['scale', 'crop']. Default 'scale'.
allow_remote (bool): indicates to the server that it should not
attempt to fetch the media if it is deemed remote. Defaults
to true if not provided.
"""
if method not in ['scale', 'crop']:
raise ValueError(
"Unsupported thumb method '%s'" % method
)
query_params = {
"width": width,
"height": height,
"method": method
}
if not allow_remote:
query_params["allow_remote"] = False
if mxcurl.startswith('mxc://'):
return self._send(
"GET", mxcurl[6:],
query_params=query_params,
api_path="/_matrix/media/r0/thumbnail/",
return_json=False
)
else:
raise ValueError(
"MXC URL '%s' did not begin with 'mxc://'" % mxcurl
)
|
python
|
def get_thumbnail(self, mxcurl, width, height, method='scale', allow_remote=True):
"""Download raw media thumbnail from provided mxc URL.
Args:
mxcurl (str): mxc media URL
width (int): desired thumbnail width
height (int): desired thumbnail height
method (str): thumb creation method. Must be
in ['scale', 'crop']. Default 'scale'.
allow_remote (bool): indicates to the server that it should not
attempt to fetch the media if it is deemed remote. Defaults
to true if not provided.
"""
if method not in ['scale', 'crop']:
raise ValueError(
"Unsupported thumb method '%s'" % method
)
query_params = {
"width": width,
"height": height,
"method": method
}
if not allow_remote:
query_params["allow_remote"] = False
if mxcurl.startswith('mxc://'):
return self._send(
"GET", mxcurl[6:],
query_params=query_params,
api_path="/_matrix/media/r0/thumbnail/",
return_json=False
)
else:
raise ValueError(
"MXC URL '%s' did not begin with 'mxc://'" % mxcurl
)
|
[
"def",
"get_thumbnail",
"(",
"self",
",",
"mxcurl",
",",
"width",
",",
"height",
",",
"method",
"=",
"'scale'",
",",
"allow_remote",
"=",
"True",
")",
":",
"if",
"method",
"not",
"in",
"[",
"'scale'",
",",
"'crop'",
"]",
":",
"raise",
"ValueError",
"(",
"\"Unsupported thumb method '%s'\"",
"%",
"method",
")",
"query_params",
"=",
"{",
"\"width\"",
":",
"width",
",",
"\"height\"",
":",
"height",
",",
"\"method\"",
":",
"method",
"}",
"if",
"not",
"allow_remote",
":",
"query_params",
"[",
"\"allow_remote\"",
"]",
"=",
"False",
"if",
"mxcurl",
".",
"startswith",
"(",
"'mxc://'",
")",
":",
"return",
"self",
".",
"_send",
"(",
"\"GET\"",
",",
"mxcurl",
"[",
"6",
":",
"]",
",",
"query_params",
"=",
"query_params",
",",
"api_path",
"=",
"\"/_matrix/media/r0/thumbnail/\"",
",",
"return_json",
"=",
"False",
")",
"else",
":",
"raise",
"ValueError",
"(",
"\"MXC URL '%s' did not begin with 'mxc://'\"",
"%",
"mxcurl",
")"
] |
Download raw media thumbnail from provided mxc URL.
Args:
mxcurl (str): mxc media URL
width (int): desired thumbnail width
height (int): desired thumbnail height
method (str): thumb creation method. Must be
in ['scale', 'crop']. Default 'scale'.
allow_remote (bool): indicates to the server that it should not
attempt to fetch the media if it is deemed remote. Defaults
to true if not provided.
|
[
"Download",
"raw",
"media",
"thumbnail",
"from",
"provided",
"mxc",
"URL",
"."
] |
e734cce3ccd35f2d355c6a19a7a701033472498a
|
https://github.com/matrix-org/matrix-python-sdk/blob/e734cce3ccd35f2d355c6a19a7a701033472498a/matrix_client/api.py#L815-L849
|
233,945
|
matrix-org/matrix-python-sdk
|
matrix_client/api.py
|
MatrixHttpApi.get_url_preview
|
def get_url_preview(self, url, ts=None):
"""Get preview for URL.
Args:
url (str): URL to get a preview
ts (double): The preferred point in time to return
a preview for. The server may return a newer
version if it does not have the requested
version available.
"""
params = {'url': url}
if ts:
params['ts'] = ts
return self._send(
"GET", "",
query_params=params,
api_path="/_matrix/media/r0/preview_url"
)
|
python
|
def get_url_preview(self, url, ts=None):
"""Get preview for URL.
Args:
url (str): URL to get a preview
ts (double): The preferred point in time to return
a preview for. The server may return a newer
version if it does not have the requested
version available.
"""
params = {'url': url}
if ts:
params['ts'] = ts
return self._send(
"GET", "",
query_params=params,
api_path="/_matrix/media/r0/preview_url"
)
|
[
"def",
"get_url_preview",
"(",
"self",
",",
"url",
",",
"ts",
"=",
"None",
")",
":",
"params",
"=",
"{",
"'url'",
":",
"url",
"}",
"if",
"ts",
":",
"params",
"[",
"'ts'",
"]",
"=",
"ts",
"return",
"self",
".",
"_send",
"(",
"\"GET\"",
",",
"\"\"",
",",
"query_params",
"=",
"params",
",",
"api_path",
"=",
"\"/_matrix/media/r0/preview_url\"",
")"
] |
Get preview for URL.
Args:
url (str): URL to get a preview
ts (double): The preferred point in time to return
a preview for. The server may return a newer
version if it does not have the requested
version available.
|
[
"Get",
"preview",
"for",
"URL",
"."
] |
e734cce3ccd35f2d355c6a19a7a701033472498a
|
https://github.com/matrix-org/matrix-python-sdk/blob/e734cce3ccd35f2d355c6a19a7a701033472498a/matrix_client/api.py#L851-L868
|
233,946
|
matrix-org/matrix-python-sdk
|
matrix_client/api.py
|
MatrixHttpApi.get_room_id
|
def get_room_id(self, room_alias):
"""Get room id from its alias.
Args:
room_alias (str): The room alias name.
Returns:
Wanted room's id.
"""
content = self._send("GET", "/directory/room/{}".format(quote(room_alias)))
return content.get("room_id", None)
|
python
|
def get_room_id(self, room_alias):
"""Get room id from its alias.
Args:
room_alias (str): The room alias name.
Returns:
Wanted room's id.
"""
content = self._send("GET", "/directory/room/{}".format(quote(room_alias)))
return content.get("room_id", None)
|
[
"def",
"get_room_id",
"(",
"self",
",",
"room_alias",
")",
":",
"content",
"=",
"self",
".",
"_send",
"(",
"\"GET\"",
",",
"\"/directory/room/{}\"",
".",
"format",
"(",
"quote",
"(",
"room_alias",
")",
")",
")",
"return",
"content",
".",
"get",
"(",
"\"room_id\"",
",",
"None",
")"
] |
Get room id from its alias.
Args:
room_alias (str): The room alias name.
Returns:
Wanted room's id.
|
[
"Get",
"room",
"id",
"from",
"its",
"alias",
"."
] |
e734cce3ccd35f2d355c6a19a7a701033472498a
|
https://github.com/matrix-org/matrix-python-sdk/blob/e734cce3ccd35f2d355c6a19a7a701033472498a/matrix_client/api.py#L870-L880
|
233,947
|
matrix-org/matrix-python-sdk
|
matrix_client/api.py
|
MatrixHttpApi.set_room_alias
|
def set_room_alias(self, room_id, room_alias):
"""Set alias to room id
Args:
room_id (str): The room id.
room_alias (str): The room wanted alias name.
"""
data = {
"room_id": room_id
}
return self._send("PUT", "/directory/room/{}".format(quote(room_alias)),
content=data)
|
python
|
def set_room_alias(self, room_id, room_alias):
"""Set alias to room id
Args:
room_id (str): The room id.
room_alias (str): The room wanted alias name.
"""
data = {
"room_id": room_id
}
return self._send("PUT", "/directory/room/{}".format(quote(room_alias)),
content=data)
|
[
"def",
"set_room_alias",
"(",
"self",
",",
"room_id",
",",
"room_alias",
")",
":",
"data",
"=",
"{",
"\"room_id\"",
":",
"room_id",
"}",
"return",
"self",
".",
"_send",
"(",
"\"PUT\"",
",",
"\"/directory/room/{}\"",
".",
"format",
"(",
"quote",
"(",
"room_alias",
")",
")",
",",
"content",
"=",
"data",
")"
] |
Set alias to room id
Args:
room_id (str): The room id.
room_alias (str): The room wanted alias name.
|
[
"Set",
"alias",
"to",
"room",
"id"
] |
e734cce3ccd35f2d355c6a19a7a701033472498a
|
https://github.com/matrix-org/matrix-python-sdk/blob/e734cce3ccd35f2d355c6a19a7a701033472498a/matrix_client/api.py#L882-L894
|
233,948
|
matrix-org/matrix-python-sdk
|
matrix_client/api.py
|
MatrixHttpApi.set_join_rule
|
def set_join_rule(self, room_id, join_rule):
"""Set the rule for users wishing to join the room.
Args:
room_id(str): The room to set the rules for.
join_rule(str): The chosen rule. One of: ["public", "knock",
"invite", "private"]
"""
content = {
"join_rule": join_rule
}
return self.send_state_event(room_id, "m.room.join_rules", content)
|
python
|
def set_join_rule(self, room_id, join_rule):
"""Set the rule for users wishing to join the room.
Args:
room_id(str): The room to set the rules for.
join_rule(str): The chosen rule. One of: ["public", "knock",
"invite", "private"]
"""
content = {
"join_rule": join_rule
}
return self.send_state_event(room_id, "m.room.join_rules", content)
|
[
"def",
"set_join_rule",
"(",
"self",
",",
"room_id",
",",
"join_rule",
")",
":",
"content",
"=",
"{",
"\"join_rule\"",
":",
"join_rule",
"}",
"return",
"self",
".",
"send_state_event",
"(",
"room_id",
",",
"\"m.room.join_rules\"",
",",
"content",
")"
] |
Set the rule for users wishing to join the room.
Args:
room_id(str): The room to set the rules for.
join_rule(str): The chosen rule. One of: ["public", "knock",
"invite", "private"]
|
[
"Set",
"the",
"rule",
"for",
"users",
"wishing",
"to",
"join",
"the",
"room",
"."
] |
e734cce3ccd35f2d355c6a19a7a701033472498a
|
https://github.com/matrix-org/matrix-python-sdk/blob/e734cce3ccd35f2d355c6a19a7a701033472498a/matrix_client/api.py#L915-L926
|
233,949
|
matrix-org/matrix-python-sdk
|
matrix_client/api.py
|
MatrixHttpApi.set_guest_access
|
def set_guest_access(self, room_id, guest_access):
"""Set the guest access policy of the room.
Args:
room_id(str): The room to set the rules for.
guest_access(str): Wether guests can join. One of: ["can_join",
"forbidden"]
"""
content = {
"guest_access": guest_access
}
return self.send_state_event(room_id, "m.room.guest_access", content)
|
python
|
def set_guest_access(self, room_id, guest_access):
"""Set the guest access policy of the room.
Args:
room_id(str): The room to set the rules for.
guest_access(str): Wether guests can join. One of: ["can_join",
"forbidden"]
"""
content = {
"guest_access": guest_access
}
return self.send_state_event(room_id, "m.room.guest_access", content)
|
[
"def",
"set_guest_access",
"(",
"self",
",",
"room_id",
",",
"guest_access",
")",
":",
"content",
"=",
"{",
"\"guest_access\"",
":",
"guest_access",
"}",
"return",
"self",
".",
"send_state_event",
"(",
"room_id",
",",
"\"m.room.guest_access\"",
",",
"content",
")"
] |
Set the guest access policy of the room.
Args:
room_id(str): The room to set the rules for.
guest_access(str): Wether guests can join. One of: ["can_join",
"forbidden"]
|
[
"Set",
"the",
"guest",
"access",
"policy",
"of",
"the",
"room",
"."
] |
e734cce3ccd35f2d355c6a19a7a701033472498a
|
https://github.com/matrix-org/matrix-python-sdk/blob/e734cce3ccd35f2d355c6a19a7a701033472498a/matrix_client/api.py#L928-L939
|
233,950
|
matrix-org/matrix-python-sdk
|
matrix_client/api.py
|
MatrixHttpApi.update_device_info
|
def update_device_info(self, device_id, display_name):
"""Update the display name of a device.
Args:
device_id (str): The device ID of the device to update.
display_name (str): New display name for the device.
"""
content = {
"display_name": display_name
}
return self._send("PUT", "/devices/%s" % device_id, content=content)
|
python
|
def update_device_info(self, device_id, display_name):
"""Update the display name of a device.
Args:
device_id (str): The device ID of the device to update.
display_name (str): New display name for the device.
"""
content = {
"display_name": display_name
}
return self._send("PUT", "/devices/%s" % device_id, content=content)
|
[
"def",
"update_device_info",
"(",
"self",
",",
"device_id",
",",
"display_name",
")",
":",
"content",
"=",
"{",
"\"display_name\"",
":",
"display_name",
"}",
"return",
"self",
".",
"_send",
"(",
"\"PUT\"",
",",
"\"/devices/%s\"",
"%",
"device_id",
",",
"content",
"=",
"content",
")"
] |
Update the display name of a device.
Args:
device_id (str): The device ID of the device to update.
display_name (str): New display name for the device.
|
[
"Update",
"the",
"display",
"name",
"of",
"a",
"device",
"."
] |
e734cce3ccd35f2d355c6a19a7a701033472498a
|
https://github.com/matrix-org/matrix-python-sdk/blob/e734cce3ccd35f2d355c6a19a7a701033472498a/matrix_client/api.py#L949-L959
|
233,951
|
matrix-org/matrix-python-sdk
|
matrix_client/api.py
|
MatrixHttpApi.delete_device
|
def delete_device(self, auth_body, device_id):
"""Deletes the given device, and invalidates any access token associated with it.
NOTE: This endpoint uses the User-Interactive Authentication API.
Args:
auth_body (dict): Authentication params.
device_id (str): The device ID of the device to delete.
"""
content = {
"auth": auth_body
}
return self._send("DELETE", "/devices/%s" % device_id, content=content)
|
python
|
def delete_device(self, auth_body, device_id):
"""Deletes the given device, and invalidates any access token associated with it.
NOTE: This endpoint uses the User-Interactive Authentication API.
Args:
auth_body (dict): Authentication params.
device_id (str): The device ID of the device to delete.
"""
content = {
"auth": auth_body
}
return self._send("DELETE", "/devices/%s" % device_id, content=content)
|
[
"def",
"delete_device",
"(",
"self",
",",
"auth_body",
",",
"device_id",
")",
":",
"content",
"=",
"{",
"\"auth\"",
":",
"auth_body",
"}",
"return",
"self",
".",
"_send",
"(",
"\"DELETE\"",
",",
"\"/devices/%s\"",
"%",
"device_id",
",",
"content",
"=",
"content",
")"
] |
Deletes the given device, and invalidates any access token associated with it.
NOTE: This endpoint uses the User-Interactive Authentication API.
Args:
auth_body (dict): Authentication params.
device_id (str): The device ID of the device to delete.
|
[
"Deletes",
"the",
"given",
"device",
"and",
"invalidates",
"any",
"access",
"token",
"associated",
"with",
"it",
"."
] |
e734cce3ccd35f2d355c6a19a7a701033472498a
|
https://github.com/matrix-org/matrix-python-sdk/blob/e734cce3ccd35f2d355c6a19a7a701033472498a/matrix_client/api.py#L961-L973
|
233,952
|
matrix-org/matrix-python-sdk
|
matrix_client/api.py
|
MatrixHttpApi.delete_devices
|
def delete_devices(self, auth_body, devices):
"""Bulk deletion of devices.
NOTE: This endpoint uses the User-Interactive Authentication API.
Args:
auth_body (dict): Authentication params.
devices (list): List of device ID"s to delete.
"""
content = {
"auth": auth_body,
"devices": devices
}
return self._send("POST", "/delete_devices", content=content)
|
python
|
def delete_devices(self, auth_body, devices):
"""Bulk deletion of devices.
NOTE: This endpoint uses the User-Interactive Authentication API.
Args:
auth_body (dict): Authentication params.
devices (list): List of device ID"s to delete.
"""
content = {
"auth": auth_body,
"devices": devices
}
return self._send("POST", "/delete_devices", content=content)
|
[
"def",
"delete_devices",
"(",
"self",
",",
"auth_body",
",",
"devices",
")",
":",
"content",
"=",
"{",
"\"auth\"",
":",
"auth_body",
",",
"\"devices\"",
":",
"devices",
"}",
"return",
"self",
".",
"_send",
"(",
"\"POST\"",
",",
"\"/delete_devices\"",
",",
"content",
"=",
"content",
")"
] |
Bulk deletion of devices.
NOTE: This endpoint uses the User-Interactive Authentication API.
Args:
auth_body (dict): Authentication params.
devices (list): List of device ID"s to delete.
|
[
"Bulk",
"deletion",
"of",
"devices",
"."
] |
e734cce3ccd35f2d355c6a19a7a701033472498a
|
https://github.com/matrix-org/matrix-python-sdk/blob/e734cce3ccd35f2d355c6a19a7a701033472498a/matrix_client/api.py#L975-L988
|
233,953
|
matrix-org/matrix-python-sdk
|
matrix_client/api.py
|
MatrixHttpApi.upload_keys
|
def upload_keys(self, device_keys=None, one_time_keys=None):
"""Publishes end-to-end encryption keys for the device.
Said device must be the one used when logging in.
Args:
device_keys (dict): Optional. Identity keys for the device. The required
keys are:
| user_id (str): The ID of the user the device belongs to. Must match
the user ID used when logging in.
| device_id (str): The ID of the device these keys belong to. Must match
the device ID used when logging in.
| algorithms (list<str>): The encryption algorithms supported by this
device.
| keys (dict): Public identity keys. Should be formatted as
<algorithm:device_id>: <key>.
| signatures (dict): Signatures for the device key object. Should be
formatted as <user_id>: {<algorithm:device_id>: <key>}
one_time_keys (dict): Optional. One-time public keys. Should be
formatted as <algorithm:key_id>: <key>, the key format being
determined by the algorithm.
"""
content = {}
if device_keys:
content["device_keys"] = device_keys
if one_time_keys:
content["one_time_keys"] = one_time_keys
return self._send("POST", "/keys/upload", content=content)
|
python
|
def upload_keys(self, device_keys=None, one_time_keys=None):
"""Publishes end-to-end encryption keys for the device.
Said device must be the one used when logging in.
Args:
device_keys (dict): Optional. Identity keys for the device. The required
keys are:
| user_id (str): The ID of the user the device belongs to. Must match
the user ID used when logging in.
| device_id (str): The ID of the device these keys belong to. Must match
the device ID used when logging in.
| algorithms (list<str>): The encryption algorithms supported by this
device.
| keys (dict): Public identity keys. Should be formatted as
<algorithm:device_id>: <key>.
| signatures (dict): Signatures for the device key object. Should be
formatted as <user_id>: {<algorithm:device_id>: <key>}
one_time_keys (dict): Optional. One-time public keys. Should be
formatted as <algorithm:key_id>: <key>, the key format being
determined by the algorithm.
"""
content = {}
if device_keys:
content["device_keys"] = device_keys
if one_time_keys:
content["one_time_keys"] = one_time_keys
return self._send("POST", "/keys/upload", content=content)
|
[
"def",
"upload_keys",
"(",
"self",
",",
"device_keys",
"=",
"None",
",",
"one_time_keys",
"=",
"None",
")",
":",
"content",
"=",
"{",
"}",
"if",
"device_keys",
":",
"content",
"[",
"\"device_keys\"",
"]",
"=",
"device_keys",
"if",
"one_time_keys",
":",
"content",
"[",
"\"one_time_keys\"",
"]",
"=",
"one_time_keys",
"return",
"self",
".",
"_send",
"(",
"\"POST\"",
",",
"\"/keys/upload\"",
",",
"content",
"=",
"content",
")"
] |
Publishes end-to-end encryption keys for the device.
Said device must be the one used when logging in.
Args:
device_keys (dict): Optional. Identity keys for the device. The required
keys are:
| user_id (str): The ID of the user the device belongs to. Must match
the user ID used when logging in.
| device_id (str): The ID of the device these keys belong to. Must match
the device ID used when logging in.
| algorithms (list<str>): The encryption algorithms supported by this
device.
| keys (dict): Public identity keys. Should be formatted as
<algorithm:device_id>: <key>.
| signatures (dict): Signatures for the device key object. Should be
formatted as <user_id>: {<algorithm:device_id>: <key>}
one_time_keys (dict): Optional. One-time public keys. Should be
formatted as <algorithm:key_id>: <key>, the key format being
determined by the algorithm.
|
[
"Publishes",
"end",
"-",
"to",
"-",
"end",
"encryption",
"keys",
"for",
"the",
"device",
"."
] |
e734cce3ccd35f2d355c6a19a7a701033472498a
|
https://github.com/matrix-org/matrix-python-sdk/blob/e734cce3ccd35f2d355c6a19a7a701033472498a/matrix_client/api.py#L990-L1019
|
233,954
|
matrix-org/matrix-python-sdk
|
matrix_client/api.py
|
MatrixHttpApi.query_keys
|
def query_keys(self, user_devices, timeout=None, token=None):
"""Query HS for public keys by user and optionally device.
Args:
user_devices (dict): The devices whose keys to download. Should be
formatted as <user_id>: [<device_ids>]. No device_ids indicates
all devices for the corresponding user.
timeout (int): Optional. The time (in milliseconds) to wait when
downloading keys from remote servers.
token (str): Optional. If the client is fetching keys as a result of
a device update received in a sync request, this should be the
'since' token of that sync request, or any later sync token.
"""
content = {"device_keys": user_devices}
if timeout:
content["timeout"] = timeout
if token:
content["token"] = token
return self._send("POST", "/keys/query", content=content)
|
python
|
def query_keys(self, user_devices, timeout=None, token=None):
"""Query HS for public keys by user and optionally device.
Args:
user_devices (dict): The devices whose keys to download. Should be
formatted as <user_id>: [<device_ids>]. No device_ids indicates
all devices for the corresponding user.
timeout (int): Optional. The time (in milliseconds) to wait when
downloading keys from remote servers.
token (str): Optional. If the client is fetching keys as a result of
a device update received in a sync request, this should be the
'since' token of that sync request, or any later sync token.
"""
content = {"device_keys": user_devices}
if timeout:
content["timeout"] = timeout
if token:
content["token"] = token
return self._send("POST", "/keys/query", content=content)
|
[
"def",
"query_keys",
"(",
"self",
",",
"user_devices",
",",
"timeout",
"=",
"None",
",",
"token",
"=",
"None",
")",
":",
"content",
"=",
"{",
"\"device_keys\"",
":",
"user_devices",
"}",
"if",
"timeout",
":",
"content",
"[",
"\"timeout\"",
"]",
"=",
"timeout",
"if",
"token",
":",
"content",
"[",
"\"token\"",
"]",
"=",
"token",
"return",
"self",
".",
"_send",
"(",
"\"POST\"",
",",
"\"/keys/query\"",
",",
"content",
"=",
"content",
")"
] |
Query HS for public keys by user and optionally device.
Args:
user_devices (dict): The devices whose keys to download. Should be
formatted as <user_id>: [<device_ids>]. No device_ids indicates
all devices for the corresponding user.
timeout (int): Optional. The time (in milliseconds) to wait when
downloading keys from remote servers.
token (str): Optional. If the client is fetching keys as a result of
a device update received in a sync request, this should be the
'since' token of that sync request, or any later sync token.
|
[
"Query",
"HS",
"for",
"public",
"keys",
"by",
"user",
"and",
"optionally",
"device",
"."
] |
e734cce3ccd35f2d355c6a19a7a701033472498a
|
https://github.com/matrix-org/matrix-python-sdk/blob/e734cce3ccd35f2d355c6a19a7a701033472498a/matrix_client/api.py#L1021-L1039
|
233,955
|
matrix-org/matrix-python-sdk
|
matrix_client/api.py
|
MatrixHttpApi.claim_keys
|
def claim_keys(self, key_request, timeout=None):
"""Claims one-time keys for use in pre-key messages.
Args:
key_request (dict): The keys to be claimed. Format should be
<user_id>: { <device_id>: <algorithm> }.
timeout (int): Optional. The time (in milliseconds) to wait when
downloading keys from remote servers.
"""
content = {"one_time_keys": key_request}
if timeout:
content["timeout"] = timeout
return self._send("POST", "/keys/claim", content=content)
|
python
|
def claim_keys(self, key_request, timeout=None):
"""Claims one-time keys for use in pre-key messages.
Args:
key_request (dict): The keys to be claimed. Format should be
<user_id>: { <device_id>: <algorithm> }.
timeout (int): Optional. The time (in milliseconds) to wait when
downloading keys from remote servers.
"""
content = {"one_time_keys": key_request}
if timeout:
content["timeout"] = timeout
return self._send("POST", "/keys/claim", content=content)
|
[
"def",
"claim_keys",
"(",
"self",
",",
"key_request",
",",
"timeout",
"=",
"None",
")",
":",
"content",
"=",
"{",
"\"one_time_keys\"",
":",
"key_request",
"}",
"if",
"timeout",
":",
"content",
"[",
"\"timeout\"",
"]",
"=",
"timeout",
"return",
"self",
".",
"_send",
"(",
"\"POST\"",
",",
"\"/keys/claim\"",
",",
"content",
"=",
"content",
")"
] |
Claims one-time keys for use in pre-key messages.
Args:
key_request (dict): The keys to be claimed. Format should be
<user_id>: { <device_id>: <algorithm> }.
timeout (int): Optional. The time (in milliseconds) to wait when
downloading keys from remote servers.
|
[
"Claims",
"one",
"-",
"time",
"keys",
"for",
"use",
"in",
"pre",
"-",
"key",
"messages",
"."
] |
e734cce3ccd35f2d355c6a19a7a701033472498a
|
https://github.com/matrix-org/matrix-python-sdk/blob/e734cce3ccd35f2d355c6a19a7a701033472498a/matrix_client/api.py#L1041-L1053
|
233,956
|
matrix-org/matrix-python-sdk
|
matrix_client/api.py
|
MatrixHttpApi.key_changes
|
def key_changes(self, from_token, to_token):
"""Gets a list of users who have updated their device identity keys.
Args:
from_token (str): The desired start point of the list. Should be the
next_batch field from a response to an earlier call to /sync.
to_token (str): The desired end point of the list. Should be the next_batch
field from a recent call to /sync - typically the most recent such call.
"""
params = {"from": from_token, "to": to_token}
return self._send("GET", "/keys/changes", query_params=params)
|
python
|
def key_changes(self, from_token, to_token):
"""Gets a list of users who have updated their device identity keys.
Args:
from_token (str): The desired start point of the list. Should be the
next_batch field from a response to an earlier call to /sync.
to_token (str): The desired end point of the list. Should be the next_batch
field from a recent call to /sync - typically the most recent such call.
"""
params = {"from": from_token, "to": to_token}
return self._send("GET", "/keys/changes", query_params=params)
|
[
"def",
"key_changes",
"(",
"self",
",",
"from_token",
",",
"to_token",
")",
":",
"params",
"=",
"{",
"\"from\"",
":",
"from_token",
",",
"\"to\"",
":",
"to_token",
"}",
"return",
"self",
".",
"_send",
"(",
"\"GET\"",
",",
"\"/keys/changes\"",
",",
"query_params",
"=",
"params",
")"
] |
Gets a list of users who have updated their device identity keys.
Args:
from_token (str): The desired start point of the list. Should be the
next_batch field from a response to an earlier call to /sync.
to_token (str): The desired end point of the list. Should be the next_batch
field from a recent call to /sync - typically the most recent such call.
|
[
"Gets",
"a",
"list",
"of",
"users",
"who",
"have",
"updated",
"their",
"device",
"identity",
"keys",
"."
] |
e734cce3ccd35f2d355c6a19a7a701033472498a
|
https://github.com/matrix-org/matrix-python-sdk/blob/e734cce3ccd35f2d355c6a19a7a701033472498a/matrix_client/api.py#L1055-L1065
|
233,957
|
matrix-org/matrix-python-sdk
|
matrix_client/api.py
|
MatrixHttpApi.send_to_device
|
def send_to_device(self, event_type, messages, txn_id=None):
"""Sends send-to-device events to a set of client devices.
Args:
event_type (str): The type of event to send.
messages (dict): The messages to send. Format should be
<user_id>: {<device_id>: <event_content>}.
The device ID may also be '*', meaning all known devices for the user.
txn_id (str): Optional. The transaction ID for this event, will be generated
automatically otherwise.
"""
txn_id = txn_id if txn_id else self._make_txn_id()
return self._send(
"PUT",
"/sendToDevice/{}/{}".format(event_type, txn_id),
content={"messages": messages}
)
|
python
|
def send_to_device(self, event_type, messages, txn_id=None):
"""Sends send-to-device events to a set of client devices.
Args:
event_type (str): The type of event to send.
messages (dict): The messages to send. Format should be
<user_id>: {<device_id>: <event_content>}.
The device ID may also be '*', meaning all known devices for the user.
txn_id (str): Optional. The transaction ID for this event, will be generated
automatically otherwise.
"""
txn_id = txn_id if txn_id else self._make_txn_id()
return self._send(
"PUT",
"/sendToDevice/{}/{}".format(event_type, txn_id),
content={"messages": messages}
)
|
[
"def",
"send_to_device",
"(",
"self",
",",
"event_type",
",",
"messages",
",",
"txn_id",
"=",
"None",
")",
":",
"txn_id",
"=",
"txn_id",
"if",
"txn_id",
"else",
"self",
".",
"_make_txn_id",
"(",
")",
"return",
"self",
".",
"_send",
"(",
"\"PUT\"",
",",
"\"/sendToDevice/{}/{}\"",
".",
"format",
"(",
"event_type",
",",
"txn_id",
")",
",",
"content",
"=",
"{",
"\"messages\"",
":",
"messages",
"}",
")"
] |
Sends send-to-device events to a set of client devices.
Args:
event_type (str): The type of event to send.
messages (dict): The messages to send. Format should be
<user_id>: {<device_id>: <event_content>}.
The device ID may also be '*', meaning all known devices for the user.
txn_id (str): Optional. The transaction ID for this event, will be generated
automatically otherwise.
|
[
"Sends",
"send",
"-",
"to",
"-",
"device",
"events",
"to",
"a",
"set",
"of",
"client",
"devices",
"."
] |
e734cce3ccd35f2d355c6a19a7a701033472498a
|
https://github.com/matrix-org/matrix-python-sdk/blob/e734cce3ccd35f2d355c6a19a7a701033472498a/matrix_client/api.py#L1067-L1083
|
233,958
|
matrix-org/matrix-python-sdk
|
matrix_client/client.py
|
MatrixClient.register_with_password
|
def register_with_password(self, username, password):
""" Register for a new account on this HS.
Args:
username (str): Account username
password (str): Account password
Returns:
str: Access Token
Raises:
MatrixRequestError
"""
response = self.api.register(
auth_body={"type": "m.login.dummy"},
kind='user',
username=username,
password=password,
)
return self._post_registration(response)
|
python
|
def register_with_password(self, username, password):
""" Register for a new account on this HS.
Args:
username (str): Account username
password (str): Account password
Returns:
str: Access Token
Raises:
MatrixRequestError
"""
response = self.api.register(
auth_body={"type": "m.login.dummy"},
kind='user',
username=username,
password=password,
)
return self._post_registration(response)
|
[
"def",
"register_with_password",
"(",
"self",
",",
"username",
",",
"password",
")",
":",
"response",
"=",
"self",
".",
"api",
".",
"register",
"(",
"auth_body",
"=",
"{",
"\"type\"",
":",
"\"m.login.dummy\"",
"}",
",",
"kind",
"=",
"'user'",
",",
"username",
"=",
"username",
",",
"password",
"=",
"password",
",",
")",
"return",
"self",
".",
"_post_registration",
"(",
"response",
")"
] |
Register for a new account on this HS.
Args:
username (str): Account username
password (str): Account password
Returns:
str: Access Token
Raises:
MatrixRequestError
|
[
"Register",
"for",
"a",
"new",
"account",
"on",
"this",
"HS",
"."
] |
e734cce3ccd35f2d355c6a19a7a701033472498a
|
https://github.com/matrix-org/matrix-python-sdk/blob/e734cce3ccd35f2d355c6a19a7a701033472498a/matrix_client/client.py#L190-L209
|
233,959
|
matrix-org/matrix-python-sdk
|
matrix_client/client.py
|
MatrixClient.login_with_password_no_sync
|
def login_with_password_no_sync(self, username, password):
"""Deprecated. Use ``login`` with ``sync=False``.
Login to the homeserver.
Args:
username (str): Account username
password (str): Account password
Returns:
str: Access token
Raises:
MatrixRequestError
"""
warn("login_with_password_no_sync is deprecated. Use login with sync=False.",
DeprecationWarning)
return self.login(username, password, sync=False)
|
python
|
def login_with_password_no_sync(self, username, password):
"""Deprecated. Use ``login`` with ``sync=False``.
Login to the homeserver.
Args:
username (str): Account username
password (str): Account password
Returns:
str: Access token
Raises:
MatrixRequestError
"""
warn("login_with_password_no_sync is deprecated. Use login with sync=False.",
DeprecationWarning)
return self.login(username, password, sync=False)
|
[
"def",
"login_with_password_no_sync",
"(",
"self",
",",
"username",
",",
"password",
")",
":",
"warn",
"(",
"\"login_with_password_no_sync is deprecated. Use login with sync=False.\"",
",",
"DeprecationWarning",
")",
"return",
"self",
".",
"login",
"(",
"username",
",",
"password",
",",
"sync",
"=",
"False",
")"
] |
Deprecated. Use ``login`` with ``sync=False``.
Login to the homeserver.
Args:
username (str): Account username
password (str): Account password
Returns:
str: Access token
Raises:
MatrixRequestError
|
[
"Deprecated",
".",
"Use",
"login",
"with",
"sync",
"=",
"False",
"."
] |
e734cce3ccd35f2d355c6a19a7a701033472498a
|
https://github.com/matrix-org/matrix-python-sdk/blob/e734cce3ccd35f2d355c6a19a7a701033472498a/matrix_client/client.py#L219-L236
|
233,960
|
matrix-org/matrix-python-sdk
|
matrix_client/client.py
|
MatrixClient.login_with_password
|
def login_with_password(self, username, password, limit=10):
"""Deprecated. Use ``login`` with ``sync=True``.
Login to the homeserver.
Args:
username (str): Account username
password (str): Account password
limit (int): Deprecated. How many messages to return when syncing.
This will be replaced by a filter API in a later release.
Returns:
str: Access token
Raises:
MatrixRequestError
"""
warn("login_with_password is deprecated. Use login with sync=True.",
DeprecationWarning)
return self.login(username, password, limit, sync=True)
|
python
|
def login_with_password(self, username, password, limit=10):
"""Deprecated. Use ``login`` with ``sync=True``.
Login to the homeserver.
Args:
username (str): Account username
password (str): Account password
limit (int): Deprecated. How many messages to return when syncing.
This will be replaced by a filter API in a later release.
Returns:
str: Access token
Raises:
MatrixRequestError
"""
warn("login_with_password is deprecated. Use login with sync=True.",
DeprecationWarning)
return self.login(username, password, limit, sync=True)
|
[
"def",
"login_with_password",
"(",
"self",
",",
"username",
",",
"password",
",",
"limit",
"=",
"10",
")",
":",
"warn",
"(",
"\"login_with_password is deprecated. Use login with sync=True.\"",
",",
"DeprecationWarning",
")",
"return",
"self",
".",
"login",
"(",
"username",
",",
"password",
",",
"limit",
",",
"sync",
"=",
"True",
")"
] |
Deprecated. Use ``login`` with ``sync=True``.
Login to the homeserver.
Args:
username (str): Account username
password (str): Account password
limit (int): Deprecated. How many messages to return when syncing.
This will be replaced by a filter API in a later release.
Returns:
str: Access token
Raises:
MatrixRequestError
|
[
"Deprecated",
".",
"Use",
"login",
"with",
"sync",
"=",
"True",
"."
] |
e734cce3ccd35f2d355c6a19a7a701033472498a
|
https://github.com/matrix-org/matrix-python-sdk/blob/e734cce3ccd35f2d355c6a19a7a701033472498a/matrix_client/client.py#L238-L257
|
233,961
|
matrix-org/matrix-python-sdk
|
matrix_client/client.py
|
MatrixClient.login
|
def login(self, username, password, limit=10, sync=True, device_id=None):
"""Login to the homeserver.
Args:
username (str): Account username
password (str): Account password
limit (int): Deprecated. How many messages to return when syncing.
This will be replaced by a filter API in a later release.
sync (bool): Optional. Whether to initiate a /sync request after logging in.
device_id (str): Optional. ID of the client device. The server will
auto-generate a device_id if this is not specified.
Returns:
str: Access token
Raises:
MatrixRequestError
"""
response = self.api.login(
"m.login.password", user=username, password=password, device_id=device_id
)
self.user_id = response["user_id"]
self.token = response["access_token"]
self.hs = response["home_server"]
self.api.token = self.token
self.device_id = response["device_id"]
if self._encryption:
self.olm_device = OlmDevice(
self.api, self.user_id, self.device_id, **self.encryption_conf)
self.olm_device.upload_identity_keys()
self.olm_device.upload_one_time_keys()
if sync:
""" Limit Filter """
self.sync_filter = '{ "room": { "timeline" : { "limit" : %i } } }' % limit
self._sync()
return self.token
|
python
|
def login(self, username, password, limit=10, sync=True, device_id=None):
"""Login to the homeserver.
Args:
username (str): Account username
password (str): Account password
limit (int): Deprecated. How many messages to return when syncing.
This will be replaced by a filter API in a later release.
sync (bool): Optional. Whether to initiate a /sync request after logging in.
device_id (str): Optional. ID of the client device. The server will
auto-generate a device_id if this is not specified.
Returns:
str: Access token
Raises:
MatrixRequestError
"""
response = self.api.login(
"m.login.password", user=username, password=password, device_id=device_id
)
self.user_id = response["user_id"]
self.token = response["access_token"]
self.hs = response["home_server"]
self.api.token = self.token
self.device_id = response["device_id"]
if self._encryption:
self.olm_device = OlmDevice(
self.api, self.user_id, self.device_id, **self.encryption_conf)
self.olm_device.upload_identity_keys()
self.olm_device.upload_one_time_keys()
if sync:
""" Limit Filter """
self.sync_filter = '{ "room": { "timeline" : { "limit" : %i } } }' % limit
self._sync()
return self.token
|
[
"def",
"login",
"(",
"self",
",",
"username",
",",
"password",
",",
"limit",
"=",
"10",
",",
"sync",
"=",
"True",
",",
"device_id",
"=",
"None",
")",
":",
"response",
"=",
"self",
".",
"api",
".",
"login",
"(",
"\"m.login.password\"",
",",
"user",
"=",
"username",
",",
"password",
"=",
"password",
",",
"device_id",
"=",
"device_id",
")",
"self",
".",
"user_id",
"=",
"response",
"[",
"\"user_id\"",
"]",
"self",
".",
"token",
"=",
"response",
"[",
"\"access_token\"",
"]",
"self",
".",
"hs",
"=",
"response",
"[",
"\"home_server\"",
"]",
"self",
".",
"api",
".",
"token",
"=",
"self",
".",
"token",
"self",
".",
"device_id",
"=",
"response",
"[",
"\"device_id\"",
"]",
"if",
"self",
".",
"_encryption",
":",
"self",
".",
"olm_device",
"=",
"OlmDevice",
"(",
"self",
".",
"api",
",",
"self",
".",
"user_id",
",",
"self",
".",
"device_id",
",",
"*",
"*",
"self",
".",
"encryption_conf",
")",
"self",
".",
"olm_device",
".",
"upload_identity_keys",
"(",
")",
"self",
".",
"olm_device",
".",
"upload_one_time_keys",
"(",
")",
"if",
"sync",
":",
"\"\"\" Limit Filter \"\"\"",
"self",
".",
"sync_filter",
"=",
"'{ \"room\": { \"timeline\" : { \"limit\" : %i } } }'",
"%",
"limit",
"self",
".",
"_sync",
"(",
")",
"return",
"self",
".",
"token"
] |
Login to the homeserver.
Args:
username (str): Account username
password (str): Account password
limit (int): Deprecated. How many messages to return when syncing.
This will be replaced by a filter API in a later release.
sync (bool): Optional. Whether to initiate a /sync request after logging in.
device_id (str): Optional. ID of the client device. The server will
auto-generate a device_id if this is not specified.
Returns:
str: Access token
Raises:
MatrixRequestError
|
[
"Login",
"to",
"the",
"homeserver",
"."
] |
e734cce3ccd35f2d355c6a19a7a701033472498a
|
https://github.com/matrix-org/matrix-python-sdk/blob/e734cce3ccd35f2d355c6a19a7a701033472498a/matrix_client/client.py#L259-L296
|
233,962
|
matrix-org/matrix-python-sdk
|
matrix_client/client.py
|
MatrixClient.create_room
|
def create_room(self, alias=None, is_public=False, invitees=None):
""" Create a new room on the homeserver.
Args:
alias (str): The canonical_alias of the room.
is_public (bool): The public/private visibility of the room.
invitees (str[]): A set of user ids to invite into the room.
Returns:
Room
Raises:
MatrixRequestError
"""
response = self.api.create_room(alias=alias,
is_public=is_public,
invitees=invitees)
return self._mkroom(response["room_id"])
|
python
|
def create_room(self, alias=None, is_public=False, invitees=None):
""" Create a new room on the homeserver.
Args:
alias (str): The canonical_alias of the room.
is_public (bool): The public/private visibility of the room.
invitees (str[]): A set of user ids to invite into the room.
Returns:
Room
Raises:
MatrixRequestError
"""
response = self.api.create_room(alias=alias,
is_public=is_public,
invitees=invitees)
return self._mkroom(response["room_id"])
|
[
"def",
"create_room",
"(",
"self",
",",
"alias",
"=",
"None",
",",
"is_public",
"=",
"False",
",",
"invitees",
"=",
"None",
")",
":",
"response",
"=",
"self",
".",
"api",
".",
"create_room",
"(",
"alias",
"=",
"alias",
",",
"is_public",
"=",
"is_public",
",",
"invitees",
"=",
"invitees",
")",
"return",
"self",
".",
"_mkroom",
"(",
"response",
"[",
"\"room_id\"",
"]",
")"
] |
Create a new room on the homeserver.
Args:
alias (str): The canonical_alias of the room.
is_public (bool): The public/private visibility of the room.
invitees (str[]): A set of user ids to invite into the room.
Returns:
Room
Raises:
MatrixRequestError
|
[
"Create",
"a",
"new",
"room",
"on",
"the",
"homeserver",
"."
] |
e734cce3ccd35f2d355c6a19a7a701033472498a
|
https://github.com/matrix-org/matrix-python-sdk/blob/e734cce3ccd35f2d355c6a19a7a701033472498a/matrix_client/client.py#L306-L323
|
233,963
|
matrix-org/matrix-python-sdk
|
matrix_client/client.py
|
MatrixClient.add_listener
|
def add_listener(self, callback, event_type=None):
""" Add a listener that will send a callback when the client recieves
an event.
Args:
callback (func(roomchunk)): Callback called when an event arrives.
event_type (str): The event_type to filter for.
Returns:
uuid.UUID: Unique id of the listener, can be used to identify the listener.
"""
listener_uid = uuid4()
# TODO: listeners should be stored in dict and accessed/deleted directly. Add
# convenience method such that MatrixClient.listeners.new(Listener(...)) performs
# MatrixClient.listeners[uuid4()] = Listener(...)
self.listeners.append(
{
'uid': listener_uid,
'callback': callback,
'event_type': event_type
}
)
return listener_uid
|
python
|
def add_listener(self, callback, event_type=None):
""" Add a listener that will send a callback when the client recieves
an event.
Args:
callback (func(roomchunk)): Callback called when an event arrives.
event_type (str): The event_type to filter for.
Returns:
uuid.UUID: Unique id of the listener, can be used to identify the listener.
"""
listener_uid = uuid4()
# TODO: listeners should be stored in dict and accessed/deleted directly. Add
# convenience method such that MatrixClient.listeners.new(Listener(...)) performs
# MatrixClient.listeners[uuid4()] = Listener(...)
self.listeners.append(
{
'uid': listener_uid,
'callback': callback,
'event_type': event_type
}
)
return listener_uid
|
[
"def",
"add_listener",
"(",
"self",
",",
"callback",
",",
"event_type",
"=",
"None",
")",
":",
"listener_uid",
"=",
"uuid4",
"(",
")",
"# TODO: listeners should be stored in dict and accessed/deleted directly. Add",
"# convenience method such that MatrixClient.listeners.new(Listener(...)) performs",
"# MatrixClient.listeners[uuid4()] = Listener(...)",
"self",
".",
"listeners",
".",
"append",
"(",
"{",
"'uid'",
":",
"listener_uid",
",",
"'callback'",
":",
"callback",
",",
"'event_type'",
":",
"event_type",
"}",
")",
"return",
"listener_uid"
] |
Add a listener that will send a callback when the client recieves
an event.
Args:
callback (func(roomchunk)): Callback called when an event arrives.
event_type (str): The event_type to filter for.
Returns:
uuid.UUID: Unique id of the listener, can be used to identify the listener.
|
[
"Add",
"a",
"listener",
"that",
"will",
"send",
"a",
"callback",
"when",
"the",
"client",
"recieves",
"an",
"event",
"."
] |
e734cce3ccd35f2d355c6a19a7a701033472498a
|
https://github.com/matrix-org/matrix-python-sdk/blob/e734cce3ccd35f2d355c6a19a7a701033472498a/matrix_client/client.py#L355-L377
|
233,964
|
matrix-org/matrix-python-sdk
|
matrix_client/client.py
|
MatrixClient.add_presence_listener
|
def add_presence_listener(self, callback):
""" Add a presence listener that will send a callback when the client receives
a presence update.
Args:
callback (func(roomchunk)): Callback called when a presence update arrives.
Returns:
uuid.UUID: Unique id of the listener, can be used to identify the listener.
"""
listener_uid = uuid4()
self.presence_listeners[listener_uid] = callback
return listener_uid
|
python
|
def add_presence_listener(self, callback):
""" Add a presence listener that will send a callback when the client receives
a presence update.
Args:
callback (func(roomchunk)): Callback called when a presence update arrives.
Returns:
uuid.UUID: Unique id of the listener, can be used to identify the listener.
"""
listener_uid = uuid4()
self.presence_listeners[listener_uid] = callback
return listener_uid
|
[
"def",
"add_presence_listener",
"(",
"self",
",",
"callback",
")",
":",
"listener_uid",
"=",
"uuid4",
"(",
")",
"self",
".",
"presence_listeners",
"[",
"listener_uid",
"]",
"=",
"callback",
"return",
"listener_uid"
] |
Add a presence listener that will send a callback when the client receives
a presence update.
Args:
callback (func(roomchunk)): Callback called when a presence update arrives.
Returns:
uuid.UUID: Unique id of the listener, can be used to identify the listener.
|
[
"Add",
"a",
"presence",
"listener",
"that",
"will",
"send",
"a",
"callback",
"when",
"the",
"client",
"receives",
"a",
"presence",
"update",
"."
] |
e734cce3ccd35f2d355c6a19a7a701033472498a
|
https://github.com/matrix-org/matrix-python-sdk/blob/e734cce3ccd35f2d355c6a19a7a701033472498a/matrix_client/client.py#L388-L400
|
233,965
|
matrix-org/matrix-python-sdk
|
matrix_client/client.py
|
MatrixClient.listen_forever
|
def listen_forever(self, timeout_ms=30000, exception_handler=None,
bad_sync_timeout=5):
""" Keep listening for events forever.
Args:
timeout_ms (int): How long to poll the Home Server for before
retrying.
exception_handler (func(exception)): Optional exception handler
function which can be used to handle exceptions in the caller
thread.
bad_sync_timeout (int): Base time to wait after an error before
retrying. Will be increased according to exponential backoff.
"""
_bad_sync_timeout = bad_sync_timeout
self.should_listen = True
while (self.should_listen):
try:
self._sync(timeout_ms)
_bad_sync_timeout = bad_sync_timeout
# TODO: we should also handle MatrixHttpLibError for retry in case no response
except MatrixRequestError as e:
logger.warning("A MatrixRequestError occured during sync.")
if e.code >= 500:
logger.warning("Problem occured serverside. Waiting %i seconds",
bad_sync_timeout)
sleep(bad_sync_timeout)
_bad_sync_timeout = min(_bad_sync_timeout * 2,
self.bad_sync_timeout_limit)
elif exception_handler is not None:
exception_handler(e)
else:
raise
except Exception as e:
logger.exception("Exception thrown during sync")
if exception_handler is not None:
exception_handler(e)
else:
raise
|
python
|
def listen_forever(self, timeout_ms=30000, exception_handler=None,
bad_sync_timeout=5):
""" Keep listening for events forever.
Args:
timeout_ms (int): How long to poll the Home Server for before
retrying.
exception_handler (func(exception)): Optional exception handler
function which can be used to handle exceptions in the caller
thread.
bad_sync_timeout (int): Base time to wait after an error before
retrying. Will be increased according to exponential backoff.
"""
_bad_sync_timeout = bad_sync_timeout
self.should_listen = True
while (self.should_listen):
try:
self._sync(timeout_ms)
_bad_sync_timeout = bad_sync_timeout
# TODO: we should also handle MatrixHttpLibError for retry in case no response
except MatrixRequestError as e:
logger.warning("A MatrixRequestError occured during sync.")
if e.code >= 500:
logger.warning("Problem occured serverside. Waiting %i seconds",
bad_sync_timeout)
sleep(bad_sync_timeout)
_bad_sync_timeout = min(_bad_sync_timeout * 2,
self.bad_sync_timeout_limit)
elif exception_handler is not None:
exception_handler(e)
else:
raise
except Exception as e:
logger.exception("Exception thrown during sync")
if exception_handler is not None:
exception_handler(e)
else:
raise
|
[
"def",
"listen_forever",
"(",
"self",
",",
"timeout_ms",
"=",
"30000",
",",
"exception_handler",
"=",
"None",
",",
"bad_sync_timeout",
"=",
"5",
")",
":",
"_bad_sync_timeout",
"=",
"bad_sync_timeout",
"self",
".",
"should_listen",
"=",
"True",
"while",
"(",
"self",
".",
"should_listen",
")",
":",
"try",
":",
"self",
".",
"_sync",
"(",
"timeout_ms",
")",
"_bad_sync_timeout",
"=",
"bad_sync_timeout",
"# TODO: we should also handle MatrixHttpLibError for retry in case no response",
"except",
"MatrixRequestError",
"as",
"e",
":",
"logger",
".",
"warning",
"(",
"\"A MatrixRequestError occured during sync.\"",
")",
"if",
"e",
".",
"code",
">=",
"500",
":",
"logger",
".",
"warning",
"(",
"\"Problem occured serverside. Waiting %i seconds\"",
",",
"bad_sync_timeout",
")",
"sleep",
"(",
"bad_sync_timeout",
")",
"_bad_sync_timeout",
"=",
"min",
"(",
"_bad_sync_timeout",
"*",
"2",
",",
"self",
".",
"bad_sync_timeout_limit",
")",
"elif",
"exception_handler",
"is",
"not",
"None",
":",
"exception_handler",
"(",
"e",
")",
"else",
":",
"raise",
"except",
"Exception",
"as",
"e",
":",
"logger",
".",
"exception",
"(",
"\"Exception thrown during sync\"",
")",
"if",
"exception_handler",
"is",
"not",
"None",
":",
"exception_handler",
"(",
"e",
")",
"else",
":",
"raise"
] |
Keep listening for events forever.
Args:
timeout_ms (int): How long to poll the Home Server for before
retrying.
exception_handler (func(exception)): Optional exception handler
function which can be used to handle exceptions in the caller
thread.
bad_sync_timeout (int): Base time to wait after an error before
retrying. Will be increased according to exponential backoff.
|
[
"Keep",
"listening",
"for",
"events",
"forever",
"."
] |
e734cce3ccd35f2d355c6a19a7a701033472498a
|
https://github.com/matrix-org/matrix-python-sdk/blob/e734cce3ccd35f2d355c6a19a7a701033472498a/matrix_client/client.py#L473-L510
|
233,966
|
matrix-org/matrix-python-sdk
|
matrix_client/client.py
|
MatrixClient.start_listener_thread
|
def start_listener_thread(self, timeout_ms=30000, exception_handler=None):
""" Start a listener thread to listen for events in the background.
Args:
timeout (int): How long to poll the Home Server for before
retrying.
exception_handler (func(exception)): Optional exception handler
function which can be used to handle exceptions in the caller
thread.
"""
try:
thread = Thread(target=self.listen_forever,
args=(timeout_ms, exception_handler))
thread.daemon = True
self.sync_thread = thread
self.should_listen = True
thread.start()
except RuntimeError:
e = sys.exc_info()[0]
logger.error("Error: unable to start thread. %s", str(e))
|
python
|
def start_listener_thread(self, timeout_ms=30000, exception_handler=None):
""" Start a listener thread to listen for events in the background.
Args:
timeout (int): How long to poll the Home Server for before
retrying.
exception_handler (func(exception)): Optional exception handler
function which can be used to handle exceptions in the caller
thread.
"""
try:
thread = Thread(target=self.listen_forever,
args=(timeout_ms, exception_handler))
thread.daemon = True
self.sync_thread = thread
self.should_listen = True
thread.start()
except RuntimeError:
e = sys.exc_info()[0]
logger.error("Error: unable to start thread. %s", str(e))
|
[
"def",
"start_listener_thread",
"(",
"self",
",",
"timeout_ms",
"=",
"30000",
",",
"exception_handler",
"=",
"None",
")",
":",
"try",
":",
"thread",
"=",
"Thread",
"(",
"target",
"=",
"self",
".",
"listen_forever",
",",
"args",
"=",
"(",
"timeout_ms",
",",
"exception_handler",
")",
")",
"thread",
".",
"daemon",
"=",
"True",
"self",
".",
"sync_thread",
"=",
"thread",
"self",
".",
"should_listen",
"=",
"True",
"thread",
".",
"start",
"(",
")",
"except",
"RuntimeError",
":",
"e",
"=",
"sys",
".",
"exc_info",
"(",
")",
"[",
"0",
"]",
"logger",
".",
"error",
"(",
"\"Error: unable to start thread. %s\"",
",",
"str",
"(",
"e",
")",
")"
] |
Start a listener thread to listen for events in the background.
Args:
timeout (int): How long to poll the Home Server for before
retrying.
exception_handler (func(exception)): Optional exception handler
function which can be used to handle exceptions in the caller
thread.
|
[
"Start",
"a",
"listener",
"thread",
"to",
"listen",
"for",
"events",
"in",
"the",
"background",
"."
] |
e734cce3ccd35f2d355c6a19a7a701033472498a
|
https://github.com/matrix-org/matrix-python-sdk/blob/e734cce3ccd35f2d355c6a19a7a701033472498a/matrix_client/client.py#L512-L531
|
233,967
|
matrix-org/matrix-python-sdk
|
matrix_client/client.py
|
MatrixClient.stop_listener_thread
|
def stop_listener_thread(self):
""" Stop listener thread running in the background
"""
if self.sync_thread:
self.should_listen = False
self.sync_thread.join()
self.sync_thread = None
|
python
|
def stop_listener_thread(self):
""" Stop listener thread running in the background
"""
if self.sync_thread:
self.should_listen = False
self.sync_thread.join()
self.sync_thread = None
|
[
"def",
"stop_listener_thread",
"(",
"self",
")",
":",
"if",
"self",
".",
"sync_thread",
":",
"self",
".",
"should_listen",
"=",
"False",
"self",
".",
"sync_thread",
".",
"join",
"(",
")",
"self",
".",
"sync_thread",
"=",
"None"
] |
Stop listener thread running in the background
|
[
"Stop",
"listener",
"thread",
"running",
"in",
"the",
"background"
] |
e734cce3ccd35f2d355c6a19a7a701033472498a
|
https://github.com/matrix-org/matrix-python-sdk/blob/e734cce3ccd35f2d355c6a19a7a701033472498a/matrix_client/client.py#L533-L539
|
233,968
|
matrix-org/matrix-python-sdk
|
matrix_client/client.py
|
MatrixClient.upload
|
def upload(self, content, content_type, filename=None):
""" Upload content to the home server and recieve a MXC url.
Args:
content (bytes): The data of the content.
content_type (str): The mimetype of the content.
filename (str): Optional. Filename of the content.
Raises:
MatrixUnexpectedResponse: If the homeserver gave a strange response
MatrixRequestError: If the upload failed for some reason.
"""
try:
response = self.api.media_upload(content, content_type, filename)
if "content_uri" in response:
return response["content_uri"]
else:
raise MatrixUnexpectedResponse(
"The upload was successful, but content_uri wasn't found."
)
except MatrixRequestError as e:
raise MatrixRequestError(
code=e.code,
content="Upload failed: %s" % e
)
|
python
|
def upload(self, content, content_type, filename=None):
""" Upload content to the home server and recieve a MXC url.
Args:
content (bytes): The data of the content.
content_type (str): The mimetype of the content.
filename (str): Optional. Filename of the content.
Raises:
MatrixUnexpectedResponse: If the homeserver gave a strange response
MatrixRequestError: If the upload failed for some reason.
"""
try:
response = self.api.media_upload(content, content_type, filename)
if "content_uri" in response:
return response["content_uri"]
else:
raise MatrixUnexpectedResponse(
"The upload was successful, but content_uri wasn't found."
)
except MatrixRequestError as e:
raise MatrixRequestError(
code=e.code,
content="Upload failed: %s" % e
)
|
[
"def",
"upload",
"(",
"self",
",",
"content",
",",
"content_type",
",",
"filename",
"=",
"None",
")",
":",
"try",
":",
"response",
"=",
"self",
".",
"api",
".",
"media_upload",
"(",
"content",
",",
"content_type",
",",
"filename",
")",
"if",
"\"content_uri\"",
"in",
"response",
":",
"return",
"response",
"[",
"\"content_uri\"",
"]",
"else",
":",
"raise",
"MatrixUnexpectedResponse",
"(",
"\"The upload was successful, but content_uri wasn't found.\"",
")",
"except",
"MatrixRequestError",
"as",
"e",
":",
"raise",
"MatrixRequestError",
"(",
"code",
"=",
"e",
".",
"code",
",",
"content",
"=",
"\"Upload failed: %s\"",
"%",
"e",
")"
] |
Upload content to the home server and recieve a MXC url.
Args:
content (bytes): The data of the content.
content_type (str): The mimetype of the content.
filename (str): Optional. Filename of the content.
Raises:
MatrixUnexpectedResponse: If the homeserver gave a strange response
MatrixRequestError: If the upload failed for some reason.
|
[
"Upload",
"content",
"to",
"the",
"home",
"server",
"and",
"recieve",
"a",
"MXC",
"url",
"."
] |
e734cce3ccd35f2d355c6a19a7a701033472498a
|
https://github.com/matrix-org/matrix-python-sdk/blob/e734cce3ccd35f2d355c6a19a7a701033472498a/matrix_client/client.py#L542-L566
|
233,969
|
matrix-org/matrix-python-sdk
|
matrix_client/client.py
|
MatrixClient.remove_room_alias
|
def remove_room_alias(self, room_alias):
"""Remove mapping of an alias
Args:
room_alias(str): The alias to be removed.
Returns:
bool: True if the alias is removed, False otherwise.
"""
try:
self.api.remove_room_alias(room_alias)
return True
except MatrixRequestError:
return False
|
python
|
def remove_room_alias(self, room_alias):
"""Remove mapping of an alias
Args:
room_alias(str): The alias to be removed.
Returns:
bool: True if the alias is removed, False otherwise.
"""
try:
self.api.remove_room_alias(room_alias)
return True
except MatrixRequestError:
return False
|
[
"def",
"remove_room_alias",
"(",
"self",
",",
"room_alias",
")",
":",
"try",
":",
"self",
".",
"api",
".",
"remove_room_alias",
"(",
"room_alias",
")",
"return",
"True",
"except",
"MatrixRequestError",
":",
"return",
"False"
] |
Remove mapping of an alias
Args:
room_alias(str): The alias to be removed.
Returns:
bool: True if the alias is removed, False otherwise.
|
[
"Remove",
"mapping",
"of",
"an",
"alias"
] |
e734cce3ccd35f2d355c6a19a7a701033472498a
|
https://github.com/matrix-org/matrix-python-sdk/blob/e734cce3ccd35f2d355c6a19a7a701033472498a/matrix_client/client.py#L656-L669
|
233,970
|
matrix-org/matrix-python-sdk
|
matrix_client/crypto/olm_device.py
|
OlmDevice.upload_identity_keys
|
def upload_identity_keys(self):
"""Uploads this device's identity keys to HS.
This device must be the one used when logging in.
"""
device_keys = {
'user_id': self.user_id,
'device_id': self.device_id,
'algorithms': self._algorithms,
'keys': {'{}:{}'.format(alg, self.device_id): key
for alg, key in self.identity_keys.items()}
}
self.sign_json(device_keys)
ret = self.api.upload_keys(device_keys=device_keys)
self.one_time_keys_manager.server_counts = ret['one_time_key_counts']
logger.info('Uploaded identity keys.')
|
python
|
def upload_identity_keys(self):
"""Uploads this device's identity keys to HS.
This device must be the one used when logging in.
"""
device_keys = {
'user_id': self.user_id,
'device_id': self.device_id,
'algorithms': self._algorithms,
'keys': {'{}:{}'.format(alg, self.device_id): key
for alg, key in self.identity_keys.items()}
}
self.sign_json(device_keys)
ret = self.api.upload_keys(device_keys=device_keys)
self.one_time_keys_manager.server_counts = ret['one_time_key_counts']
logger.info('Uploaded identity keys.')
|
[
"def",
"upload_identity_keys",
"(",
"self",
")",
":",
"device_keys",
"=",
"{",
"'user_id'",
":",
"self",
".",
"user_id",
",",
"'device_id'",
":",
"self",
".",
"device_id",
",",
"'algorithms'",
":",
"self",
".",
"_algorithms",
",",
"'keys'",
":",
"{",
"'{}:{}'",
".",
"format",
"(",
"alg",
",",
"self",
".",
"device_id",
")",
":",
"key",
"for",
"alg",
",",
"key",
"in",
"self",
".",
"identity_keys",
".",
"items",
"(",
")",
"}",
"}",
"self",
".",
"sign_json",
"(",
"device_keys",
")",
"ret",
"=",
"self",
".",
"api",
".",
"upload_keys",
"(",
"device_keys",
"=",
"device_keys",
")",
"self",
".",
"one_time_keys_manager",
".",
"server_counts",
"=",
"ret",
"[",
"'one_time_key_counts'",
"]",
"logger",
".",
"info",
"(",
"'Uploaded identity keys.'",
")"
] |
Uploads this device's identity keys to HS.
This device must be the one used when logging in.
|
[
"Uploads",
"this",
"device",
"s",
"identity",
"keys",
"to",
"HS",
"."
] |
e734cce3ccd35f2d355c6a19a7a701033472498a
|
https://github.com/matrix-org/matrix-python-sdk/blob/e734cce3ccd35f2d355c6a19a7a701033472498a/matrix_client/crypto/olm_device.py#L63-L78
|
233,971
|
matrix-org/matrix-python-sdk
|
matrix_client/crypto/olm_device.py
|
OlmDevice.upload_one_time_keys
|
def upload_one_time_keys(self, force_update=False):
"""Uploads new one-time keys to the HS, if needed.
Args:
force_update (bool): Fetch the number of one-time keys currently on the HS
before uploading, even if we already know one. In most cases this should
not be necessary, as we get this value from sync responses.
Returns:
A dict containg the number of new keys that were uploaded for each key type
(signed_curve25519 or curve25519). The format is
``<key_type>: <uploaded_number>``. If no keys of a given type have been
uploaded, the corresponding key will not be present. Consequently, an
empty dict indicates that no keys were uploaded.
"""
if force_update or not self.one_time_keys_manager.server_counts:
counts = self.api.upload_keys()['one_time_key_counts']
self.one_time_keys_manager.server_counts = counts
signed_keys_to_upload = self.one_time_keys_manager.signed_curve25519_to_upload
unsigned_keys_to_upload = self.one_time_keys_manager.curve25519_to_upload
self.olm_account.generate_one_time_keys(signed_keys_to_upload +
unsigned_keys_to_upload)
one_time_keys = {}
keys = self.olm_account.one_time_keys['curve25519']
for i, key_id in enumerate(keys):
if i < signed_keys_to_upload:
key = self.sign_json({'key': keys[key_id]})
key_type = 'signed_curve25519'
else:
key = keys[key_id]
key_type = 'curve25519'
one_time_keys['{}:{}'.format(key_type, key_id)] = key
ret = self.api.upload_keys(one_time_keys=one_time_keys)
self.one_time_keys_manager.server_counts = ret['one_time_key_counts']
self.olm_account.mark_keys_as_published()
keys_uploaded = {}
if unsigned_keys_to_upload:
keys_uploaded['curve25519'] = unsigned_keys_to_upload
if signed_keys_to_upload:
keys_uploaded['signed_curve25519'] = signed_keys_to_upload
logger.info('Uploaded new one-time keys: %s.', keys_uploaded)
return keys_uploaded
|
python
|
def upload_one_time_keys(self, force_update=False):
"""Uploads new one-time keys to the HS, if needed.
Args:
force_update (bool): Fetch the number of one-time keys currently on the HS
before uploading, even if we already know one. In most cases this should
not be necessary, as we get this value from sync responses.
Returns:
A dict containg the number of new keys that were uploaded for each key type
(signed_curve25519 or curve25519). The format is
``<key_type>: <uploaded_number>``. If no keys of a given type have been
uploaded, the corresponding key will not be present. Consequently, an
empty dict indicates that no keys were uploaded.
"""
if force_update or not self.one_time_keys_manager.server_counts:
counts = self.api.upload_keys()['one_time_key_counts']
self.one_time_keys_manager.server_counts = counts
signed_keys_to_upload = self.one_time_keys_manager.signed_curve25519_to_upload
unsigned_keys_to_upload = self.one_time_keys_manager.curve25519_to_upload
self.olm_account.generate_one_time_keys(signed_keys_to_upload +
unsigned_keys_to_upload)
one_time_keys = {}
keys = self.olm_account.one_time_keys['curve25519']
for i, key_id in enumerate(keys):
if i < signed_keys_to_upload:
key = self.sign_json({'key': keys[key_id]})
key_type = 'signed_curve25519'
else:
key = keys[key_id]
key_type = 'curve25519'
one_time_keys['{}:{}'.format(key_type, key_id)] = key
ret = self.api.upload_keys(one_time_keys=one_time_keys)
self.one_time_keys_manager.server_counts = ret['one_time_key_counts']
self.olm_account.mark_keys_as_published()
keys_uploaded = {}
if unsigned_keys_to_upload:
keys_uploaded['curve25519'] = unsigned_keys_to_upload
if signed_keys_to_upload:
keys_uploaded['signed_curve25519'] = signed_keys_to_upload
logger.info('Uploaded new one-time keys: %s.', keys_uploaded)
return keys_uploaded
|
[
"def",
"upload_one_time_keys",
"(",
"self",
",",
"force_update",
"=",
"False",
")",
":",
"if",
"force_update",
"or",
"not",
"self",
".",
"one_time_keys_manager",
".",
"server_counts",
":",
"counts",
"=",
"self",
".",
"api",
".",
"upload_keys",
"(",
")",
"[",
"'one_time_key_counts'",
"]",
"self",
".",
"one_time_keys_manager",
".",
"server_counts",
"=",
"counts",
"signed_keys_to_upload",
"=",
"self",
".",
"one_time_keys_manager",
".",
"signed_curve25519_to_upload",
"unsigned_keys_to_upload",
"=",
"self",
".",
"one_time_keys_manager",
".",
"curve25519_to_upload",
"self",
".",
"olm_account",
".",
"generate_one_time_keys",
"(",
"signed_keys_to_upload",
"+",
"unsigned_keys_to_upload",
")",
"one_time_keys",
"=",
"{",
"}",
"keys",
"=",
"self",
".",
"olm_account",
".",
"one_time_keys",
"[",
"'curve25519'",
"]",
"for",
"i",
",",
"key_id",
"in",
"enumerate",
"(",
"keys",
")",
":",
"if",
"i",
"<",
"signed_keys_to_upload",
":",
"key",
"=",
"self",
".",
"sign_json",
"(",
"{",
"'key'",
":",
"keys",
"[",
"key_id",
"]",
"}",
")",
"key_type",
"=",
"'signed_curve25519'",
"else",
":",
"key",
"=",
"keys",
"[",
"key_id",
"]",
"key_type",
"=",
"'curve25519'",
"one_time_keys",
"[",
"'{}:{}'",
".",
"format",
"(",
"key_type",
",",
"key_id",
")",
"]",
"=",
"key",
"ret",
"=",
"self",
".",
"api",
".",
"upload_keys",
"(",
"one_time_keys",
"=",
"one_time_keys",
")",
"self",
".",
"one_time_keys_manager",
".",
"server_counts",
"=",
"ret",
"[",
"'one_time_key_counts'",
"]",
"self",
".",
"olm_account",
".",
"mark_keys_as_published",
"(",
")",
"keys_uploaded",
"=",
"{",
"}",
"if",
"unsigned_keys_to_upload",
":",
"keys_uploaded",
"[",
"'curve25519'",
"]",
"=",
"unsigned_keys_to_upload",
"if",
"signed_keys_to_upload",
":",
"keys_uploaded",
"[",
"'signed_curve25519'",
"]",
"=",
"signed_keys_to_upload",
"logger",
".",
"info",
"(",
"'Uploaded new one-time keys: %s.'",
",",
"keys_uploaded",
")",
"return",
"keys_uploaded"
] |
Uploads new one-time keys to the HS, if needed.
Args:
force_update (bool): Fetch the number of one-time keys currently on the HS
before uploading, even if we already know one. In most cases this should
not be necessary, as we get this value from sync responses.
Returns:
A dict containg the number of new keys that were uploaded for each key type
(signed_curve25519 or curve25519). The format is
``<key_type>: <uploaded_number>``. If no keys of a given type have been
uploaded, the corresponding key will not be present. Consequently, an
empty dict indicates that no keys were uploaded.
|
[
"Uploads",
"new",
"one",
"-",
"time",
"keys",
"to",
"the",
"HS",
"if",
"needed",
"."
] |
e734cce3ccd35f2d355c6a19a7a701033472498a
|
https://github.com/matrix-org/matrix-python-sdk/blob/e734cce3ccd35f2d355c6a19a7a701033472498a/matrix_client/crypto/olm_device.py#L80-L126
|
233,972
|
matrix-org/matrix-python-sdk
|
matrix_client/crypto/olm_device.py
|
OlmDevice.update_one_time_key_counts
|
def update_one_time_key_counts(self, counts):
"""Update data on one-time keys count and upload new ones if necessary.
Args:
counts (dict): Counts of keys currently on the HS for each key type.
"""
self.one_time_keys_manager.server_counts = counts
if self.one_time_keys_manager.should_upload():
logger.info('Uploading new one-time keys.')
self.upload_one_time_keys()
|
python
|
def update_one_time_key_counts(self, counts):
"""Update data on one-time keys count and upload new ones if necessary.
Args:
counts (dict): Counts of keys currently on the HS for each key type.
"""
self.one_time_keys_manager.server_counts = counts
if self.one_time_keys_manager.should_upload():
logger.info('Uploading new one-time keys.')
self.upload_one_time_keys()
|
[
"def",
"update_one_time_key_counts",
"(",
"self",
",",
"counts",
")",
":",
"self",
".",
"one_time_keys_manager",
".",
"server_counts",
"=",
"counts",
"if",
"self",
".",
"one_time_keys_manager",
".",
"should_upload",
"(",
")",
":",
"logger",
".",
"info",
"(",
"'Uploading new one-time keys.'",
")",
"self",
".",
"upload_one_time_keys",
"(",
")"
] |
Update data on one-time keys count and upload new ones if necessary.
Args:
counts (dict): Counts of keys currently on the HS for each key type.
|
[
"Update",
"data",
"on",
"one",
"-",
"time",
"keys",
"count",
"and",
"upload",
"new",
"ones",
"if",
"necessary",
"."
] |
e734cce3ccd35f2d355c6a19a7a701033472498a
|
https://github.com/matrix-org/matrix-python-sdk/blob/e734cce3ccd35f2d355c6a19a7a701033472498a/matrix_client/crypto/olm_device.py#L128-L137
|
233,973
|
matrix-org/matrix-python-sdk
|
matrix_client/crypto/olm_device.py
|
OlmDevice.sign_json
|
def sign_json(self, json):
"""Signs a JSON object.
NOTE: The object is modified in-place and the return value can be ignored.
As specified, this is done by encoding the JSON object without ``signatures`` or
keys grouped as ``unsigned``, using canonical encoding.
Args:
json (dict): The JSON object to sign.
Returns:
The same JSON object, with a ``signatures`` key added. It is formatted as
``"signatures": ed25519:<device_id>: <base64_signature>``.
"""
signatures = json.pop('signatures', {})
unsigned = json.pop('unsigned', None)
signature_base64 = self.olm_account.sign(encode_canonical_json(json))
key_id = 'ed25519:{}'.format(self.device_id)
signatures.setdefault(self.user_id, {})[key_id] = signature_base64
json['signatures'] = signatures
if unsigned:
json['unsigned'] = unsigned
return json
|
python
|
def sign_json(self, json):
"""Signs a JSON object.
NOTE: The object is modified in-place and the return value can be ignored.
As specified, this is done by encoding the JSON object without ``signatures`` or
keys grouped as ``unsigned``, using canonical encoding.
Args:
json (dict): The JSON object to sign.
Returns:
The same JSON object, with a ``signatures`` key added. It is formatted as
``"signatures": ed25519:<device_id>: <base64_signature>``.
"""
signatures = json.pop('signatures', {})
unsigned = json.pop('unsigned', None)
signature_base64 = self.olm_account.sign(encode_canonical_json(json))
key_id = 'ed25519:{}'.format(self.device_id)
signatures.setdefault(self.user_id, {})[key_id] = signature_base64
json['signatures'] = signatures
if unsigned:
json['unsigned'] = unsigned
return json
|
[
"def",
"sign_json",
"(",
"self",
",",
"json",
")",
":",
"signatures",
"=",
"json",
".",
"pop",
"(",
"'signatures'",
",",
"{",
"}",
")",
"unsigned",
"=",
"json",
".",
"pop",
"(",
"'unsigned'",
",",
"None",
")",
"signature_base64",
"=",
"self",
".",
"olm_account",
".",
"sign",
"(",
"encode_canonical_json",
"(",
"json",
")",
")",
"key_id",
"=",
"'ed25519:{}'",
".",
"format",
"(",
"self",
".",
"device_id",
")",
"signatures",
".",
"setdefault",
"(",
"self",
".",
"user_id",
",",
"{",
"}",
")",
"[",
"key_id",
"]",
"=",
"signature_base64",
"json",
"[",
"'signatures'",
"]",
"=",
"signatures",
"if",
"unsigned",
":",
"json",
"[",
"'unsigned'",
"]",
"=",
"unsigned",
"return",
"json"
] |
Signs a JSON object.
NOTE: The object is modified in-place and the return value can be ignored.
As specified, this is done by encoding the JSON object without ``signatures`` or
keys grouped as ``unsigned``, using canonical encoding.
Args:
json (dict): The JSON object to sign.
Returns:
The same JSON object, with a ``signatures`` key added. It is formatted as
``"signatures": ed25519:<device_id>: <base64_signature>``.
|
[
"Signs",
"a",
"JSON",
"object",
"."
] |
e734cce3ccd35f2d355c6a19a7a701033472498a
|
https://github.com/matrix-org/matrix-python-sdk/blob/e734cce3ccd35f2d355c6a19a7a701033472498a/matrix_client/crypto/olm_device.py#L139-L166
|
233,974
|
matrix-org/matrix-python-sdk
|
matrix_client/crypto/olm_device.py
|
OlmDevice.verify_json
|
def verify_json(self, json, user_key, user_id, device_id):
"""Verifies a signed key object's signature.
The object must have a 'signatures' key associated with an object of the form
`user_id: {key_id: signature}`.
Args:
json (dict): The JSON object to verify.
user_key (str): The public ed25519 key which was used to sign the object.
user_id (str): The user who owns the device.
device_id (str): The device who owns the key.
Returns:
True if the verification was successful, False if not.
"""
try:
signatures = json.pop('signatures')
except KeyError:
return False
key_id = 'ed25519:{}'.format(device_id)
try:
signature_base64 = signatures[user_id][key_id]
except KeyError:
json['signatures'] = signatures
return False
unsigned = json.pop('unsigned', None)
try:
olm.ed25519_verify(user_key, encode_canonical_json(json), signature_base64)
success = True
except olm.utility.OlmVerifyError:
success = False
json['signatures'] = signatures
if unsigned:
json['unsigned'] = unsigned
return success
|
python
|
def verify_json(self, json, user_key, user_id, device_id):
"""Verifies a signed key object's signature.
The object must have a 'signatures' key associated with an object of the form
`user_id: {key_id: signature}`.
Args:
json (dict): The JSON object to verify.
user_key (str): The public ed25519 key which was used to sign the object.
user_id (str): The user who owns the device.
device_id (str): The device who owns the key.
Returns:
True if the verification was successful, False if not.
"""
try:
signatures = json.pop('signatures')
except KeyError:
return False
key_id = 'ed25519:{}'.format(device_id)
try:
signature_base64 = signatures[user_id][key_id]
except KeyError:
json['signatures'] = signatures
return False
unsigned = json.pop('unsigned', None)
try:
olm.ed25519_verify(user_key, encode_canonical_json(json), signature_base64)
success = True
except olm.utility.OlmVerifyError:
success = False
json['signatures'] = signatures
if unsigned:
json['unsigned'] = unsigned
return success
|
[
"def",
"verify_json",
"(",
"self",
",",
"json",
",",
"user_key",
",",
"user_id",
",",
"device_id",
")",
":",
"try",
":",
"signatures",
"=",
"json",
".",
"pop",
"(",
"'signatures'",
")",
"except",
"KeyError",
":",
"return",
"False",
"key_id",
"=",
"'ed25519:{}'",
".",
"format",
"(",
"device_id",
")",
"try",
":",
"signature_base64",
"=",
"signatures",
"[",
"user_id",
"]",
"[",
"key_id",
"]",
"except",
"KeyError",
":",
"json",
"[",
"'signatures'",
"]",
"=",
"signatures",
"return",
"False",
"unsigned",
"=",
"json",
".",
"pop",
"(",
"'unsigned'",
",",
"None",
")",
"try",
":",
"olm",
".",
"ed25519_verify",
"(",
"user_key",
",",
"encode_canonical_json",
"(",
"json",
")",
",",
"signature_base64",
")",
"success",
"=",
"True",
"except",
"olm",
".",
"utility",
".",
"OlmVerifyError",
":",
"success",
"=",
"False",
"json",
"[",
"'signatures'",
"]",
"=",
"signatures",
"if",
"unsigned",
":",
"json",
"[",
"'unsigned'",
"]",
"=",
"unsigned",
"return",
"success"
] |
Verifies a signed key object's signature.
The object must have a 'signatures' key associated with an object of the form
`user_id: {key_id: signature}`.
Args:
json (dict): The JSON object to verify.
user_key (str): The public ed25519 key which was used to sign the object.
user_id (str): The user who owns the device.
device_id (str): The device who owns the key.
Returns:
True if the verification was successful, False if not.
|
[
"Verifies",
"a",
"signed",
"key",
"object",
"s",
"signature",
"."
] |
e734cce3ccd35f2d355c6a19a7a701033472498a
|
https://github.com/matrix-org/matrix-python-sdk/blob/e734cce3ccd35f2d355c6a19a7a701033472498a/matrix_client/crypto/olm_device.py#L168-L207
|
233,975
|
matrix-org/matrix-python-sdk
|
matrix_client/user.py
|
User.get_display_name
|
def get_display_name(self, room=None):
"""Get this user's display name.
Args:
room (Room): Optional. When specified, return the display name of the user
in this room.
Returns:
The display name. Defaults to the user ID if not set.
"""
if room:
try:
return room.members_displaynames[self.user_id]
except KeyError:
return self.user_id
if not self.displayname:
self.displayname = self.api.get_display_name(self.user_id)
return self.displayname or self.user_id
|
python
|
def get_display_name(self, room=None):
"""Get this user's display name.
Args:
room (Room): Optional. When specified, return the display name of the user
in this room.
Returns:
The display name. Defaults to the user ID if not set.
"""
if room:
try:
return room.members_displaynames[self.user_id]
except KeyError:
return self.user_id
if not self.displayname:
self.displayname = self.api.get_display_name(self.user_id)
return self.displayname or self.user_id
|
[
"def",
"get_display_name",
"(",
"self",
",",
"room",
"=",
"None",
")",
":",
"if",
"room",
":",
"try",
":",
"return",
"room",
".",
"members_displaynames",
"[",
"self",
".",
"user_id",
"]",
"except",
"KeyError",
":",
"return",
"self",
".",
"user_id",
"if",
"not",
"self",
".",
"displayname",
":",
"self",
".",
"displayname",
"=",
"self",
".",
"api",
".",
"get_display_name",
"(",
"self",
".",
"user_id",
")",
"return",
"self",
".",
"displayname",
"or",
"self",
".",
"user_id"
] |
Get this user's display name.
Args:
room (Room): Optional. When specified, return the display name of the user
in this room.
Returns:
The display name. Defaults to the user ID if not set.
|
[
"Get",
"this",
"user",
"s",
"display",
"name",
"."
] |
e734cce3ccd35f2d355c6a19a7a701033472498a
|
https://github.com/matrix-org/matrix-python-sdk/blob/e734cce3ccd35f2d355c6a19a7a701033472498a/matrix_client/user.py#L30-L47
|
233,976
|
matrix-org/matrix-python-sdk
|
matrix_client/user.py
|
User.set_display_name
|
def set_display_name(self, display_name):
""" Set this users display name.
Args:
display_name (str): Display Name
"""
self.displayname = display_name
return self.api.set_display_name(self.user_id, display_name)
|
python
|
def set_display_name(self, display_name):
""" Set this users display name.
Args:
display_name (str): Display Name
"""
self.displayname = display_name
return self.api.set_display_name(self.user_id, display_name)
|
[
"def",
"set_display_name",
"(",
"self",
",",
"display_name",
")",
":",
"self",
".",
"displayname",
"=",
"display_name",
"return",
"self",
".",
"api",
".",
"set_display_name",
"(",
"self",
".",
"user_id",
",",
"display_name",
")"
] |
Set this users display name.
Args:
display_name (str): Display Name
|
[
"Set",
"this",
"users",
"display",
"name",
"."
] |
e734cce3ccd35f2d355c6a19a7a701033472498a
|
https://github.com/matrix-org/matrix-python-sdk/blob/e734cce3ccd35f2d355c6a19a7a701033472498a/matrix_client/user.py#L55-L62
|
233,977
|
diyan/pywinrm
|
winrm/encryption.py
|
Encryption.prepare_encrypted_request
|
def prepare_encrypted_request(self, session, endpoint, message):
"""
Creates a prepared request to send to the server with an encrypted message
and correct headers
:param session: The handle of the session to prepare requests with
:param endpoint: The endpoint/server to prepare requests to
:param message: The unencrypted message to send to the server
:return: A prepared request that has an encrypted message
"""
host = urlsplit(endpoint).hostname
if self.protocol == 'credssp' and len(message) > self.SIXTEN_KB:
content_type = 'multipart/x-multi-encrypted'
encrypted_message = b''
message_chunks = [message[i:i+self.SIXTEN_KB] for i in range(0, len(message), self.SIXTEN_KB)]
for message_chunk in message_chunks:
encrypted_chunk = self._encrypt_message(message_chunk, host)
encrypted_message += encrypted_chunk
else:
content_type = 'multipart/encrypted'
encrypted_message = self._encrypt_message(message, host)
encrypted_message += self.MIME_BOUNDARY + b"--\r\n"
request = requests.Request('POST', endpoint, data=encrypted_message)
prepared_request = session.prepare_request(request)
prepared_request.headers['Content-Length'] = str(len(prepared_request.body))
prepared_request.headers['Content-Type'] = '{0};protocol="{1}";boundary="Encrypted Boundary"'\
.format(content_type, self.protocol_string.decode())
return prepared_request
|
python
|
def prepare_encrypted_request(self, session, endpoint, message):
"""
Creates a prepared request to send to the server with an encrypted message
and correct headers
:param session: The handle of the session to prepare requests with
:param endpoint: The endpoint/server to prepare requests to
:param message: The unencrypted message to send to the server
:return: A prepared request that has an encrypted message
"""
host = urlsplit(endpoint).hostname
if self.protocol == 'credssp' and len(message) > self.SIXTEN_KB:
content_type = 'multipart/x-multi-encrypted'
encrypted_message = b''
message_chunks = [message[i:i+self.SIXTEN_KB] for i in range(0, len(message), self.SIXTEN_KB)]
for message_chunk in message_chunks:
encrypted_chunk = self._encrypt_message(message_chunk, host)
encrypted_message += encrypted_chunk
else:
content_type = 'multipart/encrypted'
encrypted_message = self._encrypt_message(message, host)
encrypted_message += self.MIME_BOUNDARY + b"--\r\n"
request = requests.Request('POST', endpoint, data=encrypted_message)
prepared_request = session.prepare_request(request)
prepared_request.headers['Content-Length'] = str(len(prepared_request.body))
prepared_request.headers['Content-Type'] = '{0};protocol="{1}";boundary="Encrypted Boundary"'\
.format(content_type, self.protocol_string.decode())
return prepared_request
|
[
"def",
"prepare_encrypted_request",
"(",
"self",
",",
"session",
",",
"endpoint",
",",
"message",
")",
":",
"host",
"=",
"urlsplit",
"(",
"endpoint",
")",
".",
"hostname",
"if",
"self",
".",
"protocol",
"==",
"'credssp'",
"and",
"len",
"(",
"message",
")",
">",
"self",
".",
"SIXTEN_KB",
":",
"content_type",
"=",
"'multipart/x-multi-encrypted'",
"encrypted_message",
"=",
"b''",
"message_chunks",
"=",
"[",
"message",
"[",
"i",
":",
"i",
"+",
"self",
".",
"SIXTEN_KB",
"]",
"for",
"i",
"in",
"range",
"(",
"0",
",",
"len",
"(",
"message",
")",
",",
"self",
".",
"SIXTEN_KB",
")",
"]",
"for",
"message_chunk",
"in",
"message_chunks",
":",
"encrypted_chunk",
"=",
"self",
".",
"_encrypt_message",
"(",
"message_chunk",
",",
"host",
")",
"encrypted_message",
"+=",
"encrypted_chunk",
"else",
":",
"content_type",
"=",
"'multipart/encrypted'",
"encrypted_message",
"=",
"self",
".",
"_encrypt_message",
"(",
"message",
",",
"host",
")",
"encrypted_message",
"+=",
"self",
".",
"MIME_BOUNDARY",
"+",
"b\"--\\r\\n\"",
"request",
"=",
"requests",
".",
"Request",
"(",
"'POST'",
",",
"endpoint",
",",
"data",
"=",
"encrypted_message",
")",
"prepared_request",
"=",
"session",
".",
"prepare_request",
"(",
"request",
")",
"prepared_request",
".",
"headers",
"[",
"'Content-Length'",
"]",
"=",
"str",
"(",
"len",
"(",
"prepared_request",
".",
"body",
")",
")",
"prepared_request",
".",
"headers",
"[",
"'Content-Type'",
"]",
"=",
"'{0};protocol=\"{1}\";boundary=\"Encrypted Boundary\"'",
".",
"format",
"(",
"content_type",
",",
"self",
".",
"protocol_string",
".",
"decode",
"(",
")",
")",
"return",
"prepared_request"
] |
Creates a prepared request to send to the server with an encrypted message
and correct headers
:param session: The handle of the session to prepare requests with
:param endpoint: The endpoint/server to prepare requests to
:param message: The unencrypted message to send to the server
:return: A prepared request that has an encrypted message
|
[
"Creates",
"a",
"prepared",
"request",
"to",
"send",
"to",
"the",
"server",
"with",
"an",
"encrypted",
"message",
"and",
"correct",
"headers"
] |
ed4c2d991d9d0fe921dfc958c475c4c6a570519e
|
https://github.com/diyan/pywinrm/blob/ed4c2d991d9d0fe921dfc958c475c4c6a570519e/winrm/encryption.py#L58-L88
|
233,978
|
diyan/pywinrm
|
winrm/encryption.py
|
Encryption.parse_encrypted_response
|
def parse_encrypted_response(self, response):
"""
Takes in the encrypted response from the server and decrypts it
:param response: The response that needs to be decrytped
:return: The unencrypted message from the server
"""
content_type = response.headers['Content-Type']
if 'protocol="{0}"'.format(self.protocol_string.decode()) in content_type:
host = urlsplit(response.request.url).hostname
msg = self._decrypt_response(response, host)
else:
msg = response.text
return msg
|
python
|
def parse_encrypted_response(self, response):
"""
Takes in the encrypted response from the server and decrypts it
:param response: The response that needs to be decrytped
:return: The unencrypted message from the server
"""
content_type = response.headers['Content-Type']
if 'protocol="{0}"'.format(self.protocol_string.decode()) in content_type:
host = urlsplit(response.request.url).hostname
msg = self._decrypt_response(response, host)
else:
msg = response.text
return msg
|
[
"def",
"parse_encrypted_response",
"(",
"self",
",",
"response",
")",
":",
"content_type",
"=",
"response",
".",
"headers",
"[",
"'Content-Type'",
"]",
"if",
"'protocol=\"{0}\"'",
".",
"format",
"(",
"self",
".",
"protocol_string",
".",
"decode",
"(",
")",
")",
"in",
"content_type",
":",
"host",
"=",
"urlsplit",
"(",
"response",
".",
"request",
".",
"url",
")",
".",
"hostname",
"msg",
"=",
"self",
".",
"_decrypt_response",
"(",
"response",
",",
"host",
")",
"else",
":",
"msg",
"=",
"response",
".",
"text",
"return",
"msg"
] |
Takes in the encrypted response from the server and decrypts it
:param response: The response that needs to be decrytped
:return: The unencrypted message from the server
|
[
"Takes",
"in",
"the",
"encrypted",
"response",
"from",
"the",
"server",
"and",
"decrypts",
"it"
] |
ed4c2d991d9d0fe921dfc958c475c4c6a570519e
|
https://github.com/diyan/pywinrm/blob/ed4c2d991d9d0fe921dfc958c475c4c6a570519e/winrm/encryption.py#L90-L104
|
233,979
|
diyan/pywinrm
|
winrm/protocol.py
|
Protocol.open_shell
|
def open_shell(self, i_stream='stdin', o_stream='stdout stderr',
working_directory=None, env_vars=None, noprofile=False,
codepage=437, lifetime=None, idle_timeout=None):
"""
Create a Shell on the destination host
@param string i_stream: Which input stream to open. Leave this alone
unless you know what you're doing (default: stdin)
@param string o_stream: Which output stream to open. Leave this alone
unless you know what you're doing (default: stdout stderr)
@param string working_directory: the directory to create the shell in
@param dict env_vars: environment variables to set for the shell. For
instance: {'PATH': '%PATH%;c:/Program Files (x86)/Git/bin/', 'CYGWIN':
'nontsec codepage:utf8'}
@returns The ShellId from the SOAP response. This is our open shell
instance on the remote machine.
@rtype string
"""
req = {'env:Envelope': self._get_soap_header(
resource_uri='http://schemas.microsoft.com/wbem/wsman/1/windows/shell/cmd', # NOQA
action='http://schemas.xmlsoap.org/ws/2004/09/transfer/Create')}
header = req['env:Envelope']['env:Header']
header['w:OptionSet'] = {
'w:Option': [
{
'@Name': 'WINRS_NOPROFILE',
'#text': str(noprofile).upper() # TODO remove str call
},
{
'@Name': 'WINRS_CODEPAGE',
'#text': str(codepage) # TODO remove str call
}
]
}
shell = req['env:Envelope'].setdefault(
'env:Body', {}).setdefault('rsp:Shell', {})
shell['rsp:InputStreams'] = i_stream
shell['rsp:OutputStreams'] = o_stream
if working_directory:
# TODO ensure that rsp:WorkingDirectory should be nested within rsp:Shell # NOQA
shell['rsp:WorkingDirectory'] = working_directory
# TODO check Lifetime param: http://msdn.microsoft.com/en-us/library/cc251546(v=PROT.13).aspx # NOQA
#if lifetime:
# shell['rsp:Lifetime'] = iso8601_duration.sec_to_dur(lifetime)
# TODO make it so the input is given in milliseconds and converted to xs:duration # NOQA
if idle_timeout:
shell['rsp:IdleTimeOut'] = idle_timeout
if env_vars:
env = shell.setdefault('rsp:Environment', {})
for key, value in env_vars.items():
env['rsp:Variable'] = {'@Name': key, '#text': value}
res = self.send_message(xmltodict.unparse(req))
#res = xmltodict.parse(res)
#return res['s:Envelope']['s:Body']['x:ResourceCreated']['a:ReferenceParameters']['w:SelectorSet']['w:Selector']['#text']
root = ET.fromstring(res)
return next(
node for node in root.findall('.//*')
if node.get('Name') == 'ShellId').text
|
python
|
def open_shell(self, i_stream='stdin', o_stream='stdout stderr',
working_directory=None, env_vars=None, noprofile=False,
codepage=437, lifetime=None, idle_timeout=None):
"""
Create a Shell on the destination host
@param string i_stream: Which input stream to open. Leave this alone
unless you know what you're doing (default: stdin)
@param string o_stream: Which output stream to open. Leave this alone
unless you know what you're doing (default: stdout stderr)
@param string working_directory: the directory to create the shell in
@param dict env_vars: environment variables to set for the shell. For
instance: {'PATH': '%PATH%;c:/Program Files (x86)/Git/bin/', 'CYGWIN':
'nontsec codepage:utf8'}
@returns The ShellId from the SOAP response. This is our open shell
instance on the remote machine.
@rtype string
"""
req = {'env:Envelope': self._get_soap_header(
resource_uri='http://schemas.microsoft.com/wbem/wsman/1/windows/shell/cmd', # NOQA
action='http://schemas.xmlsoap.org/ws/2004/09/transfer/Create')}
header = req['env:Envelope']['env:Header']
header['w:OptionSet'] = {
'w:Option': [
{
'@Name': 'WINRS_NOPROFILE',
'#text': str(noprofile).upper() # TODO remove str call
},
{
'@Name': 'WINRS_CODEPAGE',
'#text': str(codepage) # TODO remove str call
}
]
}
shell = req['env:Envelope'].setdefault(
'env:Body', {}).setdefault('rsp:Shell', {})
shell['rsp:InputStreams'] = i_stream
shell['rsp:OutputStreams'] = o_stream
if working_directory:
# TODO ensure that rsp:WorkingDirectory should be nested within rsp:Shell # NOQA
shell['rsp:WorkingDirectory'] = working_directory
# TODO check Lifetime param: http://msdn.microsoft.com/en-us/library/cc251546(v=PROT.13).aspx # NOQA
#if lifetime:
# shell['rsp:Lifetime'] = iso8601_duration.sec_to_dur(lifetime)
# TODO make it so the input is given in milliseconds and converted to xs:duration # NOQA
if idle_timeout:
shell['rsp:IdleTimeOut'] = idle_timeout
if env_vars:
env = shell.setdefault('rsp:Environment', {})
for key, value in env_vars.items():
env['rsp:Variable'] = {'@Name': key, '#text': value}
res = self.send_message(xmltodict.unparse(req))
#res = xmltodict.parse(res)
#return res['s:Envelope']['s:Body']['x:ResourceCreated']['a:ReferenceParameters']['w:SelectorSet']['w:Selector']['#text']
root = ET.fromstring(res)
return next(
node for node in root.findall('.//*')
if node.get('Name') == 'ShellId').text
|
[
"def",
"open_shell",
"(",
"self",
",",
"i_stream",
"=",
"'stdin'",
",",
"o_stream",
"=",
"'stdout stderr'",
",",
"working_directory",
"=",
"None",
",",
"env_vars",
"=",
"None",
",",
"noprofile",
"=",
"False",
",",
"codepage",
"=",
"437",
",",
"lifetime",
"=",
"None",
",",
"idle_timeout",
"=",
"None",
")",
":",
"req",
"=",
"{",
"'env:Envelope'",
":",
"self",
".",
"_get_soap_header",
"(",
"resource_uri",
"=",
"'http://schemas.microsoft.com/wbem/wsman/1/windows/shell/cmd'",
",",
"# NOQA",
"action",
"=",
"'http://schemas.xmlsoap.org/ws/2004/09/transfer/Create'",
")",
"}",
"header",
"=",
"req",
"[",
"'env:Envelope'",
"]",
"[",
"'env:Header'",
"]",
"header",
"[",
"'w:OptionSet'",
"]",
"=",
"{",
"'w:Option'",
":",
"[",
"{",
"'@Name'",
":",
"'WINRS_NOPROFILE'",
",",
"'#text'",
":",
"str",
"(",
"noprofile",
")",
".",
"upper",
"(",
")",
"# TODO remove str call",
"}",
",",
"{",
"'@Name'",
":",
"'WINRS_CODEPAGE'",
",",
"'#text'",
":",
"str",
"(",
"codepage",
")",
"# TODO remove str call",
"}",
"]",
"}",
"shell",
"=",
"req",
"[",
"'env:Envelope'",
"]",
".",
"setdefault",
"(",
"'env:Body'",
",",
"{",
"}",
")",
".",
"setdefault",
"(",
"'rsp:Shell'",
",",
"{",
"}",
")",
"shell",
"[",
"'rsp:InputStreams'",
"]",
"=",
"i_stream",
"shell",
"[",
"'rsp:OutputStreams'",
"]",
"=",
"o_stream",
"if",
"working_directory",
":",
"# TODO ensure that rsp:WorkingDirectory should be nested within rsp:Shell # NOQA",
"shell",
"[",
"'rsp:WorkingDirectory'",
"]",
"=",
"working_directory",
"# TODO check Lifetime param: http://msdn.microsoft.com/en-us/library/cc251546(v=PROT.13).aspx # NOQA",
"#if lifetime:",
"# shell['rsp:Lifetime'] = iso8601_duration.sec_to_dur(lifetime)",
"# TODO make it so the input is given in milliseconds and converted to xs:duration # NOQA",
"if",
"idle_timeout",
":",
"shell",
"[",
"'rsp:IdleTimeOut'",
"]",
"=",
"idle_timeout",
"if",
"env_vars",
":",
"env",
"=",
"shell",
".",
"setdefault",
"(",
"'rsp:Environment'",
",",
"{",
"}",
")",
"for",
"key",
",",
"value",
"in",
"env_vars",
".",
"items",
"(",
")",
":",
"env",
"[",
"'rsp:Variable'",
"]",
"=",
"{",
"'@Name'",
":",
"key",
",",
"'#text'",
":",
"value",
"}",
"res",
"=",
"self",
".",
"send_message",
"(",
"xmltodict",
".",
"unparse",
"(",
"req",
")",
")",
"#res = xmltodict.parse(res)",
"#return res['s:Envelope']['s:Body']['x:ResourceCreated']['a:ReferenceParameters']['w:SelectorSet']['w:Selector']['#text']",
"root",
"=",
"ET",
".",
"fromstring",
"(",
"res",
")",
"return",
"next",
"(",
"node",
"for",
"node",
"in",
"root",
".",
"findall",
"(",
"'.//*'",
")",
"if",
"node",
".",
"get",
"(",
"'Name'",
")",
"==",
"'ShellId'",
")",
".",
"text"
] |
Create a Shell on the destination host
@param string i_stream: Which input stream to open. Leave this alone
unless you know what you're doing (default: stdin)
@param string o_stream: Which output stream to open. Leave this alone
unless you know what you're doing (default: stdout stderr)
@param string working_directory: the directory to create the shell in
@param dict env_vars: environment variables to set for the shell. For
instance: {'PATH': '%PATH%;c:/Program Files (x86)/Git/bin/', 'CYGWIN':
'nontsec codepage:utf8'}
@returns The ShellId from the SOAP response. This is our open shell
instance on the remote machine.
@rtype string
|
[
"Create",
"a",
"Shell",
"on",
"the",
"destination",
"host"
] |
ed4c2d991d9d0fe921dfc958c475c4c6a570519e
|
https://github.com/diyan/pywinrm/blob/ed4c2d991d9d0fe921dfc958c475c4c6a570519e/winrm/protocol.py#L104-L164
|
233,980
|
diyan/pywinrm
|
winrm/protocol.py
|
Protocol.close_shell
|
def close_shell(self, shell_id):
"""
Close the shell
@param string shell_id: The shell id on the remote machine.
See #open_shell
@returns This should have more error checking but it just returns true
for now.
@rtype bool
"""
message_id = uuid.uuid4()
req = {'env:Envelope': self._get_soap_header(
resource_uri='http://schemas.microsoft.com/wbem/wsman/1/windows/shell/cmd', # NOQA
action='http://schemas.xmlsoap.org/ws/2004/09/transfer/Delete',
shell_id=shell_id,
message_id=message_id)}
# SOAP message requires empty env:Body
req['env:Envelope'].setdefault('env:Body', {})
res = self.send_message(xmltodict.unparse(req))
root = ET.fromstring(res)
relates_to = next(
node for node in root.findall('.//*')
if node.tag.endswith('RelatesTo')).text
# TODO change assert into user-friendly exception
assert uuid.UUID(relates_to.replace('uuid:', '')) == message_id
|
python
|
def close_shell(self, shell_id):
"""
Close the shell
@param string shell_id: The shell id on the remote machine.
See #open_shell
@returns This should have more error checking but it just returns true
for now.
@rtype bool
"""
message_id = uuid.uuid4()
req = {'env:Envelope': self._get_soap_header(
resource_uri='http://schemas.microsoft.com/wbem/wsman/1/windows/shell/cmd', # NOQA
action='http://schemas.xmlsoap.org/ws/2004/09/transfer/Delete',
shell_id=shell_id,
message_id=message_id)}
# SOAP message requires empty env:Body
req['env:Envelope'].setdefault('env:Body', {})
res = self.send_message(xmltodict.unparse(req))
root = ET.fromstring(res)
relates_to = next(
node for node in root.findall('.//*')
if node.tag.endswith('RelatesTo')).text
# TODO change assert into user-friendly exception
assert uuid.UUID(relates_to.replace('uuid:', '')) == message_id
|
[
"def",
"close_shell",
"(",
"self",
",",
"shell_id",
")",
":",
"message_id",
"=",
"uuid",
".",
"uuid4",
"(",
")",
"req",
"=",
"{",
"'env:Envelope'",
":",
"self",
".",
"_get_soap_header",
"(",
"resource_uri",
"=",
"'http://schemas.microsoft.com/wbem/wsman/1/windows/shell/cmd'",
",",
"# NOQA",
"action",
"=",
"'http://schemas.xmlsoap.org/ws/2004/09/transfer/Delete'",
",",
"shell_id",
"=",
"shell_id",
",",
"message_id",
"=",
"message_id",
")",
"}",
"# SOAP message requires empty env:Body",
"req",
"[",
"'env:Envelope'",
"]",
".",
"setdefault",
"(",
"'env:Body'",
",",
"{",
"}",
")",
"res",
"=",
"self",
".",
"send_message",
"(",
"xmltodict",
".",
"unparse",
"(",
"req",
")",
")",
"root",
"=",
"ET",
".",
"fromstring",
"(",
"res",
")",
"relates_to",
"=",
"next",
"(",
"node",
"for",
"node",
"in",
"root",
".",
"findall",
"(",
"'.//*'",
")",
"if",
"node",
".",
"tag",
".",
"endswith",
"(",
"'RelatesTo'",
")",
")",
".",
"text",
"# TODO change assert into user-friendly exception",
"assert",
"uuid",
".",
"UUID",
"(",
"relates_to",
".",
"replace",
"(",
"'uuid:'",
",",
"''",
")",
")",
"==",
"message_id"
] |
Close the shell
@param string shell_id: The shell id on the remote machine.
See #open_shell
@returns This should have more error checking but it just returns true
for now.
@rtype bool
|
[
"Close",
"the",
"shell"
] |
ed4c2d991d9d0fe921dfc958c475c4c6a570519e
|
https://github.com/diyan/pywinrm/blob/ed4c2d991d9d0fe921dfc958c475c4c6a570519e/winrm/protocol.py#L274-L299
|
233,981
|
diyan/pywinrm
|
winrm/protocol.py
|
Protocol.run_command
|
def run_command(
self, shell_id, command, arguments=(), console_mode_stdin=True,
skip_cmd_shell=False):
"""
Run a command on a machine with an open shell
@param string shell_id: The shell id on the remote machine.
See #open_shell
@param string command: The command to run on the remote machine
@param iterable of string arguments: An array of arguments for this
command
@param bool console_mode_stdin: (default: True)
@param bool skip_cmd_shell: (default: False)
@return: The CommandId from the SOAP response.
This is the ID we need to query in order to get output.
@rtype string
"""
req = {'env:Envelope': self._get_soap_header(
resource_uri='http://schemas.microsoft.com/wbem/wsman/1/windows/shell/cmd', # NOQA
action='http://schemas.microsoft.com/wbem/wsman/1/windows/shell/Command', # NOQA
shell_id=shell_id)}
header = req['env:Envelope']['env:Header']
header['w:OptionSet'] = {
'w:Option': [
{
'@Name': 'WINRS_CONSOLEMODE_STDIN',
'#text': str(console_mode_stdin).upper()
},
{
'@Name': 'WINRS_SKIP_CMD_SHELL',
'#text': str(skip_cmd_shell).upper()
}
]
}
cmd_line = req['env:Envelope'].setdefault(
'env:Body', {}).setdefault('rsp:CommandLine', {})
cmd_line['rsp:Command'] = {'#text': command}
if arguments:
unicode_args = [a if isinstance(a, text_type) else a.decode('utf-8') for a in arguments]
cmd_line['rsp:Arguments'] = u' '.join(unicode_args)
res = self.send_message(xmltodict.unparse(req))
root = ET.fromstring(res)
command_id = next(
node for node in root.findall('.//*')
if node.tag.endswith('CommandId')).text
return command_id
|
python
|
def run_command(
self, shell_id, command, arguments=(), console_mode_stdin=True,
skip_cmd_shell=False):
"""
Run a command on a machine with an open shell
@param string shell_id: The shell id on the remote machine.
See #open_shell
@param string command: The command to run on the remote machine
@param iterable of string arguments: An array of arguments for this
command
@param bool console_mode_stdin: (default: True)
@param bool skip_cmd_shell: (default: False)
@return: The CommandId from the SOAP response.
This is the ID we need to query in order to get output.
@rtype string
"""
req = {'env:Envelope': self._get_soap_header(
resource_uri='http://schemas.microsoft.com/wbem/wsman/1/windows/shell/cmd', # NOQA
action='http://schemas.microsoft.com/wbem/wsman/1/windows/shell/Command', # NOQA
shell_id=shell_id)}
header = req['env:Envelope']['env:Header']
header['w:OptionSet'] = {
'w:Option': [
{
'@Name': 'WINRS_CONSOLEMODE_STDIN',
'#text': str(console_mode_stdin).upper()
},
{
'@Name': 'WINRS_SKIP_CMD_SHELL',
'#text': str(skip_cmd_shell).upper()
}
]
}
cmd_line = req['env:Envelope'].setdefault(
'env:Body', {}).setdefault('rsp:CommandLine', {})
cmd_line['rsp:Command'] = {'#text': command}
if arguments:
unicode_args = [a if isinstance(a, text_type) else a.decode('utf-8') for a in arguments]
cmd_line['rsp:Arguments'] = u' '.join(unicode_args)
res = self.send_message(xmltodict.unparse(req))
root = ET.fromstring(res)
command_id = next(
node for node in root.findall('.//*')
if node.tag.endswith('CommandId')).text
return command_id
|
[
"def",
"run_command",
"(",
"self",
",",
"shell_id",
",",
"command",
",",
"arguments",
"=",
"(",
")",
",",
"console_mode_stdin",
"=",
"True",
",",
"skip_cmd_shell",
"=",
"False",
")",
":",
"req",
"=",
"{",
"'env:Envelope'",
":",
"self",
".",
"_get_soap_header",
"(",
"resource_uri",
"=",
"'http://schemas.microsoft.com/wbem/wsman/1/windows/shell/cmd'",
",",
"# NOQA",
"action",
"=",
"'http://schemas.microsoft.com/wbem/wsman/1/windows/shell/Command'",
",",
"# NOQA",
"shell_id",
"=",
"shell_id",
")",
"}",
"header",
"=",
"req",
"[",
"'env:Envelope'",
"]",
"[",
"'env:Header'",
"]",
"header",
"[",
"'w:OptionSet'",
"]",
"=",
"{",
"'w:Option'",
":",
"[",
"{",
"'@Name'",
":",
"'WINRS_CONSOLEMODE_STDIN'",
",",
"'#text'",
":",
"str",
"(",
"console_mode_stdin",
")",
".",
"upper",
"(",
")",
"}",
",",
"{",
"'@Name'",
":",
"'WINRS_SKIP_CMD_SHELL'",
",",
"'#text'",
":",
"str",
"(",
"skip_cmd_shell",
")",
".",
"upper",
"(",
")",
"}",
"]",
"}",
"cmd_line",
"=",
"req",
"[",
"'env:Envelope'",
"]",
".",
"setdefault",
"(",
"'env:Body'",
",",
"{",
"}",
")",
".",
"setdefault",
"(",
"'rsp:CommandLine'",
",",
"{",
"}",
")",
"cmd_line",
"[",
"'rsp:Command'",
"]",
"=",
"{",
"'#text'",
":",
"command",
"}",
"if",
"arguments",
":",
"unicode_args",
"=",
"[",
"a",
"if",
"isinstance",
"(",
"a",
",",
"text_type",
")",
"else",
"a",
".",
"decode",
"(",
"'utf-8'",
")",
"for",
"a",
"in",
"arguments",
"]",
"cmd_line",
"[",
"'rsp:Arguments'",
"]",
"=",
"u' '",
".",
"join",
"(",
"unicode_args",
")",
"res",
"=",
"self",
".",
"send_message",
"(",
"xmltodict",
".",
"unparse",
"(",
"req",
")",
")",
"root",
"=",
"ET",
".",
"fromstring",
"(",
"res",
")",
"command_id",
"=",
"next",
"(",
"node",
"for",
"node",
"in",
"root",
".",
"findall",
"(",
"'.//*'",
")",
"if",
"node",
".",
"tag",
".",
"endswith",
"(",
"'CommandId'",
")",
")",
".",
"text",
"return",
"command_id"
] |
Run a command on a machine with an open shell
@param string shell_id: The shell id on the remote machine.
See #open_shell
@param string command: The command to run on the remote machine
@param iterable of string arguments: An array of arguments for this
command
@param bool console_mode_stdin: (default: True)
@param bool skip_cmd_shell: (default: False)
@return: The CommandId from the SOAP response.
This is the ID we need to query in order to get output.
@rtype string
|
[
"Run",
"a",
"command",
"on",
"a",
"machine",
"with",
"an",
"open",
"shell"
] |
ed4c2d991d9d0fe921dfc958c475c4c6a570519e
|
https://github.com/diyan/pywinrm/blob/ed4c2d991d9d0fe921dfc958c475c4c6a570519e/winrm/protocol.py#L301-L346
|
233,982
|
diyan/pywinrm
|
winrm/protocol.py
|
Protocol.get_command_output
|
def get_command_output(self, shell_id, command_id):
"""
Get the Output of the given shell and command
@param string shell_id: The shell id on the remote machine.
See #open_shell
@param string command_id: The command id on the remote machine.
See #run_command
#@return [Hash] Returns a Hash with a key :exitcode and :data.
Data is an Array of Hashes where the cooresponding key
# is either :stdout or :stderr. The reason it is in an Array so so
we can get the output in the order it ocurrs on
# the console.
"""
stdout_buffer, stderr_buffer = [], []
command_done = False
while not command_done:
try:
stdout, stderr, return_code, command_done = \
self._raw_get_command_output(shell_id, command_id)
stdout_buffer.append(stdout)
stderr_buffer.append(stderr)
except WinRMOperationTimeoutError as e:
# this is an expected error when waiting for a long-running process, just silently retry
pass
return b''.join(stdout_buffer), b''.join(stderr_buffer), return_code
|
python
|
def get_command_output(self, shell_id, command_id):
"""
Get the Output of the given shell and command
@param string shell_id: The shell id on the remote machine.
See #open_shell
@param string command_id: The command id on the remote machine.
See #run_command
#@return [Hash] Returns a Hash with a key :exitcode and :data.
Data is an Array of Hashes where the cooresponding key
# is either :stdout or :stderr. The reason it is in an Array so so
we can get the output in the order it ocurrs on
# the console.
"""
stdout_buffer, stderr_buffer = [], []
command_done = False
while not command_done:
try:
stdout, stderr, return_code, command_done = \
self._raw_get_command_output(shell_id, command_id)
stdout_buffer.append(stdout)
stderr_buffer.append(stderr)
except WinRMOperationTimeoutError as e:
# this is an expected error when waiting for a long-running process, just silently retry
pass
return b''.join(stdout_buffer), b''.join(stderr_buffer), return_code
|
[
"def",
"get_command_output",
"(",
"self",
",",
"shell_id",
",",
"command_id",
")",
":",
"stdout_buffer",
",",
"stderr_buffer",
"=",
"[",
"]",
",",
"[",
"]",
"command_done",
"=",
"False",
"while",
"not",
"command_done",
":",
"try",
":",
"stdout",
",",
"stderr",
",",
"return_code",
",",
"command_done",
"=",
"self",
".",
"_raw_get_command_output",
"(",
"shell_id",
",",
"command_id",
")",
"stdout_buffer",
".",
"append",
"(",
"stdout",
")",
"stderr_buffer",
".",
"append",
"(",
"stderr",
")",
"except",
"WinRMOperationTimeoutError",
"as",
"e",
":",
"# this is an expected error when waiting for a long-running process, just silently retry",
"pass",
"return",
"b''",
".",
"join",
"(",
"stdout_buffer",
")",
",",
"b''",
".",
"join",
"(",
"stderr_buffer",
")",
",",
"return_code"
] |
Get the Output of the given shell and command
@param string shell_id: The shell id on the remote machine.
See #open_shell
@param string command_id: The command id on the remote machine.
See #run_command
#@return [Hash] Returns a Hash with a key :exitcode and :data.
Data is an Array of Hashes where the cooresponding key
# is either :stdout or :stderr. The reason it is in an Array so so
we can get the output in the order it ocurrs on
# the console.
|
[
"Get",
"the",
"Output",
"of",
"the",
"given",
"shell",
"and",
"command"
] |
ed4c2d991d9d0fe921dfc958c475c4c6a570519e
|
https://github.com/diyan/pywinrm/blob/ed4c2d991d9d0fe921dfc958c475c4c6a570519e/winrm/protocol.py#L380-L404
|
233,983
|
diyan/pywinrm
|
winrm/__init__.py
|
Session.run_ps
|
def run_ps(self, script):
"""base64 encodes a Powershell script and executes the powershell
encoded script command
"""
# must use utf16 little endian on windows
encoded_ps = b64encode(script.encode('utf_16_le')).decode('ascii')
rs = self.run_cmd('powershell -encodedcommand {0}'.format(encoded_ps))
if len(rs.std_err):
# if there was an error message, clean it it up and make it human
# readable
rs.std_err = self._clean_error_msg(rs.std_err)
return rs
|
python
|
def run_ps(self, script):
"""base64 encodes a Powershell script and executes the powershell
encoded script command
"""
# must use utf16 little endian on windows
encoded_ps = b64encode(script.encode('utf_16_le')).decode('ascii')
rs = self.run_cmd('powershell -encodedcommand {0}'.format(encoded_ps))
if len(rs.std_err):
# if there was an error message, clean it it up and make it human
# readable
rs.std_err = self._clean_error_msg(rs.std_err)
return rs
|
[
"def",
"run_ps",
"(",
"self",
",",
"script",
")",
":",
"# must use utf16 little endian on windows",
"encoded_ps",
"=",
"b64encode",
"(",
"script",
".",
"encode",
"(",
"'utf_16_le'",
")",
")",
".",
"decode",
"(",
"'ascii'",
")",
"rs",
"=",
"self",
".",
"run_cmd",
"(",
"'powershell -encodedcommand {0}'",
".",
"format",
"(",
"encoded_ps",
")",
")",
"if",
"len",
"(",
"rs",
".",
"std_err",
")",
":",
"# if there was an error message, clean it it up and make it human",
"# readable",
"rs",
".",
"std_err",
"=",
"self",
".",
"_clean_error_msg",
"(",
"rs",
".",
"std_err",
")",
"return",
"rs"
] |
base64 encodes a Powershell script and executes the powershell
encoded script command
|
[
"base64",
"encodes",
"a",
"Powershell",
"script",
"and",
"executes",
"the",
"powershell",
"encoded",
"script",
"command"
] |
ed4c2d991d9d0fe921dfc958c475c4c6a570519e
|
https://github.com/diyan/pywinrm/blob/ed4c2d991d9d0fe921dfc958c475c4c6a570519e/winrm/__init__.py#L44-L55
|
233,984
|
diyan/pywinrm
|
winrm/__init__.py
|
Session._clean_error_msg
|
def _clean_error_msg(self, msg):
"""converts a Powershell CLIXML message to a more human readable string
"""
# TODO prepare unit test, beautify code
# if the msg does not start with this, return it as is
if msg.startswith(b"#< CLIXML\r\n"):
# for proper xml, we need to remove the CLIXML part
# (the first line)
msg_xml = msg[11:]
try:
# remove the namespaces from the xml for easier processing
msg_xml = self._strip_namespace(msg_xml)
root = ET.fromstring(msg_xml)
# the S node is the error message, find all S nodes
nodes = root.findall("./S")
new_msg = ""
for s in nodes:
# append error msg string to result, also
# the hex chars represent CRLF so we replace with newline
new_msg += s.text.replace("_x000D__x000A_", "\n")
except Exception as e:
# if any of the above fails, the msg was not true xml
# print a warning and return the orignal string
# TODO do not print, raise user defined error instead
print("Warning: there was a problem converting the Powershell"
" error message: %s" % (e))
else:
# if new_msg was populated, that's our error message
# otherwise the original error message will be used
if len(new_msg):
# remove leading and trailing whitespace while we are here
return new_msg.strip().encode('utf-8')
# either failed to decode CLIXML or there was nothing to decode
# just return the original message
return msg
|
python
|
def _clean_error_msg(self, msg):
"""converts a Powershell CLIXML message to a more human readable string
"""
# TODO prepare unit test, beautify code
# if the msg does not start with this, return it as is
if msg.startswith(b"#< CLIXML\r\n"):
# for proper xml, we need to remove the CLIXML part
# (the first line)
msg_xml = msg[11:]
try:
# remove the namespaces from the xml for easier processing
msg_xml = self._strip_namespace(msg_xml)
root = ET.fromstring(msg_xml)
# the S node is the error message, find all S nodes
nodes = root.findall("./S")
new_msg = ""
for s in nodes:
# append error msg string to result, also
# the hex chars represent CRLF so we replace with newline
new_msg += s.text.replace("_x000D__x000A_", "\n")
except Exception as e:
# if any of the above fails, the msg was not true xml
# print a warning and return the orignal string
# TODO do not print, raise user defined error instead
print("Warning: there was a problem converting the Powershell"
" error message: %s" % (e))
else:
# if new_msg was populated, that's our error message
# otherwise the original error message will be used
if len(new_msg):
# remove leading and trailing whitespace while we are here
return new_msg.strip().encode('utf-8')
# either failed to decode CLIXML or there was nothing to decode
# just return the original message
return msg
|
[
"def",
"_clean_error_msg",
"(",
"self",
",",
"msg",
")",
":",
"# TODO prepare unit test, beautify code",
"# if the msg does not start with this, return it as is",
"if",
"msg",
".",
"startswith",
"(",
"b\"#< CLIXML\\r\\n\"",
")",
":",
"# for proper xml, we need to remove the CLIXML part",
"# (the first line)",
"msg_xml",
"=",
"msg",
"[",
"11",
":",
"]",
"try",
":",
"# remove the namespaces from the xml for easier processing",
"msg_xml",
"=",
"self",
".",
"_strip_namespace",
"(",
"msg_xml",
")",
"root",
"=",
"ET",
".",
"fromstring",
"(",
"msg_xml",
")",
"# the S node is the error message, find all S nodes",
"nodes",
"=",
"root",
".",
"findall",
"(",
"\"./S\"",
")",
"new_msg",
"=",
"\"\"",
"for",
"s",
"in",
"nodes",
":",
"# append error msg string to result, also",
"# the hex chars represent CRLF so we replace with newline",
"new_msg",
"+=",
"s",
".",
"text",
".",
"replace",
"(",
"\"_x000D__x000A_\"",
",",
"\"\\n\"",
")",
"except",
"Exception",
"as",
"e",
":",
"# if any of the above fails, the msg was not true xml",
"# print a warning and return the orignal string",
"# TODO do not print, raise user defined error instead",
"print",
"(",
"\"Warning: there was a problem converting the Powershell\"",
"\" error message: %s\"",
"%",
"(",
"e",
")",
")",
"else",
":",
"# if new_msg was populated, that's our error message",
"# otherwise the original error message will be used",
"if",
"len",
"(",
"new_msg",
")",
":",
"# remove leading and trailing whitespace while we are here",
"return",
"new_msg",
".",
"strip",
"(",
")",
".",
"encode",
"(",
"'utf-8'",
")",
"# either failed to decode CLIXML or there was nothing to decode",
"# just return the original message",
"return",
"msg"
] |
converts a Powershell CLIXML message to a more human readable string
|
[
"converts",
"a",
"Powershell",
"CLIXML",
"message",
"to",
"a",
"more",
"human",
"readable",
"string"
] |
ed4c2d991d9d0fe921dfc958c475c4c6a570519e
|
https://github.com/diyan/pywinrm/blob/ed4c2d991d9d0fe921dfc958c475c4c6a570519e/winrm/__init__.py#L57-L92
|
233,985
|
diyan/pywinrm
|
winrm/__init__.py
|
Session._strip_namespace
|
def _strip_namespace(self, xml):
"""strips any namespaces from an xml string"""
p = re.compile(b"xmlns=*[\"\"][^\"\"]*[\"\"]")
allmatches = p.finditer(xml)
for match in allmatches:
xml = xml.replace(match.group(), b"")
return xml
|
python
|
def _strip_namespace(self, xml):
"""strips any namespaces from an xml string"""
p = re.compile(b"xmlns=*[\"\"][^\"\"]*[\"\"]")
allmatches = p.finditer(xml)
for match in allmatches:
xml = xml.replace(match.group(), b"")
return xml
|
[
"def",
"_strip_namespace",
"(",
"self",
",",
"xml",
")",
":",
"p",
"=",
"re",
".",
"compile",
"(",
"b\"xmlns=*[\\\"\\\"][^\\\"\\\"]*[\\\"\\\"]\"",
")",
"allmatches",
"=",
"p",
".",
"finditer",
"(",
"xml",
")",
"for",
"match",
"in",
"allmatches",
":",
"xml",
"=",
"xml",
".",
"replace",
"(",
"match",
".",
"group",
"(",
")",
",",
"b\"\"",
")",
"return",
"xml"
] |
strips any namespaces from an xml string
|
[
"strips",
"any",
"namespaces",
"from",
"an",
"xml",
"string"
] |
ed4c2d991d9d0fe921dfc958c475c4c6a570519e
|
https://github.com/diyan/pywinrm/blob/ed4c2d991d9d0fe921dfc958c475c4c6a570519e/winrm/__init__.py#L94-L100
|
233,986
|
pyvisa/pyvisa
|
pyvisa/errors.py
|
return_handler
|
def return_handler(module_logger, first_is_session=True):
"""Decorator for VISA library classes.
"""
def _outer(visa_library_method):
def _inner(self, session, *args, **kwargs):
ret_value = visa_library_method(*args, **kwargs)
module_logger.debug('%s%s -> %r',
visa_library_method.__name__,
_args_to_str(args, kwargs),
ret_value)
try:
ret_value = constants.StatusCode(ret_value)
except ValueError:
pass
if first_is_session:
self._last_status = ret_value
self._last_status_in_session[session] = ret_value
if ret_value < 0:
raise VisaIOError(ret_value)
if ret_value in self.issue_warning_on:
if session and ret_value not in self._ignore_warning_in_session[session]:
module_logger.warn(VisaIOWarning(ret_value), stacklevel=2)
return ret_value
return _inner
return _outer
|
python
|
def return_handler(module_logger, first_is_session=True):
"""Decorator for VISA library classes.
"""
def _outer(visa_library_method):
def _inner(self, session, *args, **kwargs):
ret_value = visa_library_method(*args, **kwargs)
module_logger.debug('%s%s -> %r',
visa_library_method.__name__,
_args_to_str(args, kwargs),
ret_value)
try:
ret_value = constants.StatusCode(ret_value)
except ValueError:
pass
if first_is_session:
self._last_status = ret_value
self._last_status_in_session[session] = ret_value
if ret_value < 0:
raise VisaIOError(ret_value)
if ret_value in self.issue_warning_on:
if session and ret_value not in self._ignore_warning_in_session[session]:
module_logger.warn(VisaIOWarning(ret_value), stacklevel=2)
return ret_value
return _inner
return _outer
|
[
"def",
"return_handler",
"(",
"module_logger",
",",
"first_is_session",
"=",
"True",
")",
":",
"def",
"_outer",
"(",
"visa_library_method",
")",
":",
"def",
"_inner",
"(",
"self",
",",
"session",
",",
"*",
"args",
",",
"*",
"*",
"kwargs",
")",
":",
"ret_value",
"=",
"visa_library_method",
"(",
"*",
"args",
",",
"*",
"*",
"kwargs",
")",
"module_logger",
".",
"debug",
"(",
"'%s%s -> %r'",
",",
"visa_library_method",
".",
"__name__",
",",
"_args_to_str",
"(",
"args",
",",
"kwargs",
")",
",",
"ret_value",
")",
"try",
":",
"ret_value",
"=",
"constants",
".",
"StatusCode",
"(",
"ret_value",
")",
"except",
"ValueError",
":",
"pass",
"if",
"first_is_session",
":",
"self",
".",
"_last_status",
"=",
"ret_value",
"self",
".",
"_last_status_in_session",
"[",
"session",
"]",
"=",
"ret_value",
"if",
"ret_value",
"<",
"0",
":",
"raise",
"VisaIOError",
"(",
"ret_value",
")",
"if",
"ret_value",
"in",
"self",
".",
"issue_warning_on",
":",
"if",
"session",
"and",
"ret_value",
"not",
"in",
"self",
".",
"_ignore_warning_in_session",
"[",
"session",
"]",
":",
"module_logger",
".",
"warn",
"(",
"VisaIOWarning",
"(",
"ret_value",
")",
",",
"stacklevel",
"=",
"2",
")",
"return",
"ret_value",
"return",
"_inner",
"return",
"_outer"
] |
Decorator for VISA library classes.
|
[
"Decorator",
"for",
"VISA",
"library",
"classes",
"."
] |
b8b2d4371e1f00782856aa9176ff1ced6bcb3798
|
https://github.com/pyvisa/pyvisa/blob/b8b2d4371e1f00782856aa9176ff1ced6bcb3798/pyvisa/errors.py#L501-L535
|
233,987
|
pyvisa/pyvisa
|
pyvisa/highlevel.py
|
list_backends
|
def list_backends():
"""Return installed backends.
Backends are installed python packages named pyvisa-<something> where <something>
is the name of the backend.
:rtype: list
"""
return ['ni'] + [name for (loader, name, ispkg) in pkgutil.iter_modules()
if name.startswith('pyvisa-') and not name.endswith('-script')]
|
python
|
def list_backends():
"""Return installed backends.
Backends are installed python packages named pyvisa-<something> where <something>
is the name of the backend.
:rtype: list
"""
return ['ni'] + [name for (loader, name, ispkg) in pkgutil.iter_modules()
if name.startswith('pyvisa-') and not name.endswith('-script')]
|
[
"def",
"list_backends",
"(",
")",
":",
"return",
"[",
"'ni'",
"]",
"+",
"[",
"name",
"for",
"(",
"loader",
",",
"name",
",",
"ispkg",
")",
"in",
"pkgutil",
".",
"iter_modules",
"(",
")",
"if",
"name",
".",
"startswith",
"(",
"'pyvisa-'",
")",
"and",
"not",
"name",
".",
"endswith",
"(",
"'-script'",
")",
"]"
] |
Return installed backends.
Backends are installed python packages named pyvisa-<something> where <something>
is the name of the backend.
:rtype: list
|
[
"Return",
"installed",
"backends",
"."
] |
b8b2d4371e1f00782856aa9176ff1ced6bcb3798
|
https://github.com/pyvisa/pyvisa/blob/b8b2d4371e1f00782856aa9176ff1ced6bcb3798/pyvisa/highlevel.py#L1412-L1421
|
233,988
|
pyvisa/pyvisa
|
pyvisa/highlevel.py
|
get_wrapper_class
|
def get_wrapper_class(backend_name):
"""Return the WRAPPER_CLASS for a given backend.
:rtype: pyvisa.highlevel.VisaLibraryBase
"""
try:
return _WRAPPERS[backend_name]
except KeyError:
if backend_name == 'ni':
from .ctwrapper import NIVisaLibrary
_WRAPPERS['ni'] = NIVisaLibrary
return NIVisaLibrary
try:
pkg = __import__('pyvisa-' + backend_name)
_WRAPPERS[backend_name] = cls = pkg.WRAPPER_CLASS
return cls
except ImportError:
raise ValueError('Wrapper not found: No package named pyvisa-%s' % backend_name)
|
python
|
def get_wrapper_class(backend_name):
"""Return the WRAPPER_CLASS for a given backend.
:rtype: pyvisa.highlevel.VisaLibraryBase
"""
try:
return _WRAPPERS[backend_name]
except KeyError:
if backend_name == 'ni':
from .ctwrapper import NIVisaLibrary
_WRAPPERS['ni'] = NIVisaLibrary
return NIVisaLibrary
try:
pkg = __import__('pyvisa-' + backend_name)
_WRAPPERS[backend_name] = cls = pkg.WRAPPER_CLASS
return cls
except ImportError:
raise ValueError('Wrapper not found: No package named pyvisa-%s' % backend_name)
|
[
"def",
"get_wrapper_class",
"(",
"backend_name",
")",
":",
"try",
":",
"return",
"_WRAPPERS",
"[",
"backend_name",
"]",
"except",
"KeyError",
":",
"if",
"backend_name",
"==",
"'ni'",
":",
"from",
".",
"ctwrapper",
"import",
"NIVisaLibrary",
"_WRAPPERS",
"[",
"'ni'",
"]",
"=",
"NIVisaLibrary",
"return",
"NIVisaLibrary",
"try",
":",
"pkg",
"=",
"__import__",
"(",
"'pyvisa-'",
"+",
"backend_name",
")",
"_WRAPPERS",
"[",
"backend_name",
"]",
"=",
"cls",
"=",
"pkg",
".",
"WRAPPER_CLASS",
"return",
"cls",
"except",
"ImportError",
":",
"raise",
"ValueError",
"(",
"'Wrapper not found: No package named pyvisa-%s'",
"%",
"backend_name",
")"
] |
Return the WRAPPER_CLASS for a given backend.
:rtype: pyvisa.highlevel.VisaLibraryBase
|
[
"Return",
"the",
"WRAPPER_CLASS",
"for",
"a",
"given",
"backend",
"."
] |
b8b2d4371e1f00782856aa9176ff1ced6bcb3798
|
https://github.com/pyvisa/pyvisa/blob/b8b2d4371e1f00782856aa9176ff1ced6bcb3798/pyvisa/highlevel.py#L1429-L1447
|
233,989
|
pyvisa/pyvisa
|
pyvisa/highlevel.py
|
open_visa_library
|
def open_visa_library(specification):
"""Helper function to create a VISA library wrapper.
In general, you should not use the function directly. The VISA library
wrapper will be created automatically when you create a ResourceManager object.
"""
if not specification:
logger.debug('No visa library specified, trying to find alternatives.')
try:
specification = os.environ['PYVISA_LIBRARY']
except KeyError:
logger.debug('Environment variable PYVISA_LIBRARY is unset.')
try:
argument, wrapper = specification.split('@')
except ValueError:
argument = specification
wrapper = None # Flag that we need a fallback, but avoid nested exceptions
if wrapper is None:
if argument: # some filename given
wrapper = 'ni'
else:
wrapper = _get_default_wrapper()
cls = get_wrapper_class(wrapper)
try:
return cls(argument)
except Exception as e:
logger.debug('Could not open VISA wrapper %s: %s\n%s', cls, str(argument), e)
raise
|
python
|
def open_visa_library(specification):
"""Helper function to create a VISA library wrapper.
In general, you should not use the function directly. The VISA library
wrapper will be created automatically when you create a ResourceManager object.
"""
if not specification:
logger.debug('No visa library specified, trying to find alternatives.')
try:
specification = os.environ['PYVISA_LIBRARY']
except KeyError:
logger.debug('Environment variable PYVISA_LIBRARY is unset.')
try:
argument, wrapper = specification.split('@')
except ValueError:
argument = specification
wrapper = None # Flag that we need a fallback, but avoid nested exceptions
if wrapper is None:
if argument: # some filename given
wrapper = 'ni'
else:
wrapper = _get_default_wrapper()
cls = get_wrapper_class(wrapper)
try:
return cls(argument)
except Exception as e:
logger.debug('Could not open VISA wrapper %s: %s\n%s', cls, str(argument), e)
raise
|
[
"def",
"open_visa_library",
"(",
"specification",
")",
":",
"if",
"not",
"specification",
":",
"logger",
".",
"debug",
"(",
"'No visa library specified, trying to find alternatives.'",
")",
"try",
":",
"specification",
"=",
"os",
".",
"environ",
"[",
"'PYVISA_LIBRARY'",
"]",
"except",
"KeyError",
":",
"logger",
".",
"debug",
"(",
"'Environment variable PYVISA_LIBRARY is unset.'",
")",
"try",
":",
"argument",
",",
"wrapper",
"=",
"specification",
".",
"split",
"(",
"'@'",
")",
"except",
"ValueError",
":",
"argument",
"=",
"specification",
"wrapper",
"=",
"None",
"# Flag that we need a fallback, but avoid nested exceptions",
"if",
"wrapper",
"is",
"None",
":",
"if",
"argument",
":",
"# some filename given",
"wrapper",
"=",
"'ni'",
"else",
":",
"wrapper",
"=",
"_get_default_wrapper",
"(",
")",
"cls",
"=",
"get_wrapper_class",
"(",
"wrapper",
")",
"try",
":",
"return",
"cls",
"(",
"argument",
")",
"except",
"Exception",
"as",
"e",
":",
"logger",
".",
"debug",
"(",
"'Could not open VISA wrapper %s: %s\\n%s'",
",",
"cls",
",",
"str",
"(",
"argument",
")",
",",
"e",
")",
"raise"
] |
Helper function to create a VISA library wrapper.
In general, you should not use the function directly. The VISA library
wrapper will be created automatically when you create a ResourceManager object.
|
[
"Helper",
"function",
"to",
"create",
"a",
"VISA",
"library",
"wrapper",
"."
] |
b8b2d4371e1f00782856aa9176ff1ced6bcb3798
|
https://github.com/pyvisa/pyvisa/blob/b8b2d4371e1f00782856aa9176ff1ced6bcb3798/pyvisa/highlevel.py#L1474-L1505
|
233,990
|
pyvisa/pyvisa
|
pyvisa/highlevel.py
|
VisaLibraryBase.get_last_status_in_session
|
def get_last_status_in_session(self, session):
"""Last status in session.
Helper function to be called by resources properties.
"""
try:
return self._last_status_in_session[session]
except KeyError:
raise errors.Error('The session %r does not seem to be valid as it does not have any last status' % session)
|
python
|
def get_last_status_in_session(self, session):
"""Last status in session.
Helper function to be called by resources properties.
"""
try:
return self._last_status_in_session[session]
except KeyError:
raise errors.Error('The session %r does not seem to be valid as it does not have any last status' % session)
|
[
"def",
"get_last_status_in_session",
"(",
"self",
",",
"session",
")",
":",
"try",
":",
"return",
"self",
".",
"_last_status_in_session",
"[",
"session",
"]",
"except",
"KeyError",
":",
"raise",
"errors",
".",
"Error",
"(",
"'The session %r does not seem to be valid as it does not have any last status'",
"%",
"session",
")"
] |
Last status in session.
Helper function to be called by resources properties.
|
[
"Last",
"status",
"in",
"session",
"."
] |
b8b2d4371e1f00782856aa9176ff1ced6bcb3798
|
https://github.com/pyvisa/pyvisa/blob/b8b2d4371e1f00782856aa9176ff1ced6bcb3798/pyvisa/highlevel.py#L154-L162
|
233,991
|
pyvisa/pyvisa
|
pyvisa/highlevel.py
|
VisaLibraryBase.ignore_warning
|
def ignore_warning(self, session, *warnings_constants):
"""A session dependent context for ignoring warnings
:param session: Unique logical identifier to a session.
:param warnings_constants: constants identifying the warnings to ignore.
"""
self._ignore_warning_in_session[session].update(warnings_constants)
yield
self._ignore_warning_in_session[session].difference_update(warnings_constants)
|
python
|
def ignore_warning(self, session, *warnings_constants):
"""A session dependent context for ignoring warnings
:param session: Unique logical identifier to a session.
:param warnings_constants: constants identifying the warnings to ignore.
"""
self._ignore_warning_in_session[session].update(warnings_constants)
yield
self._ignore_warning_in_session[session].difference_update(warnings_constants)
|
[
"def",
"ignore_warning",
"(",
"self",
",",
"session",
",",
"*",
"warnings_constants",
")",
":",
"self",
".",
"_ignore_warning_in_session",
"[",
"session",
"]",
".",
"update",
"(",
"warnings_constants",
")",
"yield",
"self",
".",
"_ignore_warning_in_session",
"[",
"session",
"]",
".",
"difference_update",
"(",
"warnings_constants",
")"
] |
A session dependent context for ignoring warnings
:param session: Unique logical identifier to a session.
:param warnings_constants: constants identifying the warnings to ignore.
|
[
"A",
"session",
"dependent",
"context",
"for",
"ignoring",
"warnings"
] |
b8b2d4371e1f00782856aa9176ff1ced6bcb3798
|
https://github.com/pyvisa/pyvisa/blob/b8b2d4371e1f00782856aa9176ff1ced6bcb3798/pyvisa/highlevel.py#L165-L173
|
233,992
|
pyvisa/pyvisa
|
pyvisa/highlevel.py
|
VisaLibraryBase.uninstall_all_visa_handlers
|
def uninstall_all_visa_handlers(self, session):
"""Uninstalls all previously installed handlers for a particular session.
:param session: Unique logical identifier to a session. If None, operates on all sessions.
"""
if session is not None:
self.__uninstall_all_handlers_helper(session)
else:
for session in list(self.handlers):
self.__uninstall_all_handlers_helper(session)
|
python
|
def uninstall_all_visa_handlers(self, session):
"""Uninstalls all previously installed handlers for a particular session.
:param session: Unique logical identifier to a session. If None, operates on all sessions.
"""
if session is not None:
self.__uninstall_all_handlers_helper(session)
else:
for session in list(self.handlers):
self.__uninstall_all_handlers_helper(session)
|
[
"def",
"uninstall_all_visa_handlers",
"(",
"self",
",",
"session",
")",
":",
"if",
"session",
"is",
"not",
"None",
":",
"self",
".",
"__uninstall_all_handlers_helper",
"(",
"session",
")",
"else",
":",
"for",
"session",
"in",
"list",
"(",
"self",
".",
"handlers",
")",
":",
"self",
".",
"__uninstall_all_handlers_helper",
"(",
"session",
")"
] |
Uninstalls all previously installed handlers for a particular session.
:param session: Unique logical identifier to a session. If None, operates on all sessions.
|
[
"Uninstalls",
"all",
"previously",
"installed",
"handlers",
"for",
"a",
"particular",
"session",
"."
] |
b8b2d4371e1f00782856aa9176ff1ced6bcb3798
|
https://github.com/pyvisa/pyvisa/blob/b8b2d4371e1f00782856aa9176ff1ced6bcb3798/pyvisa/highlevel.py#L214-L224
|
233,993
|
pyvisa/pyvisa
|
pyvisa/highlevel.py
|
VisaLibraryBase.write_memory
|
def write_memory(self, session, space, offset, data, width, extended=False):
"""Write in an 8-bit, 16-bit, 32-bit, 64-bit value to the specified memory space and offset.
Corresponds to viOut* functions of the VISA library.
:param session: Unique logical identifier to a session.
:param space: Specifies the address space. (Constants.*SPACE*)
:param offset: Offset (in bytes) of the address or register from which to read.
:param data: Data to write to bus.
:param width: Number of bits to read.
:param extended: Use 64 bits offset independent of the platform.
:return: return value of the library call.
:rtype: :class:`pyvisa.constants.StatusCode`
"""
if width == 8:
return self.out_8(session, space, offset, data, extended)
elif width == 16:
return self.out_16(session, space, offset, data, extended)
elif width == 32:
return self.out_32(session, space, offset, data, extended)
elif width == 64:
return self.out_64(session, space, offset, data, extended)
raise ValueError('%s is not a valid size. Valid values are 8, 16, 32, or 64' % width)
|
python
|
def write_memory(self, session, space, offset, data, width, extended=False):
"""Write in an 8-bit, 16-bit, 32-bit, 64-bit value to the specified memory space and offset.
Corresponds to viOut* functions of the VISA library.
:param session: Unique logical identifier to a session.
:param space: Specifies the address space. (Constants.*SPACE*)
:param offset: Offset (in bytes) of the address or register from which to read.
:param data: Data to write to bus.
:param width: Number of bits to read.
:param extended: Use 64 bits offset independent of the platform.
:return: return value of the library call.
:rtype: :class:`pyvisa.constants.StatusCode`
"""
if width == 8:
return self.out_8(session, space, offset, data, extended)
elif width == 16:
return self.out_16(session, space, offset, data, extended)
elif width == 32:
return self.out_32(session, space, offset, data, extended)
elif width == 64:
return self.out_64(session, space, offset, data, extended)
raise ValueError('%s is not a valid size. Valid values are 8, 16, 32, or 64' % width)
|
[
"def",
"write_memory",
"(",
"self",
",",
"session",
",",
"space",
",",
"offset",
",",
"data",
",",
"width",
",",
"extended",
"=",
"False",
")",
":",
"if",
"width",
"==",
"8",
":",
"return",
"self",
".",
"out_8",
"(",
"session",
",",
"space",
",",
"offset",
",",
"data",
",",
"extended",
")",
"elif",
"width",
"==",
"16",
":",
"return",
"self",
".",
"out_16",
"(",
"session",
",",
"space",
",",
"offset",
",",
"data",
",",
"extended",
")",
"elif",
"width",
"==",
"32",
":",
"return",
"self",
".",
"out_32",
"(",
"session",
",",
"space",
",",
"offset",
",",
"data",
",",
"extended",
")",
"elif",
"width",
"==",
"64",
":",
"return",
"self",
".",
"out_64",
"(",
"session",
",",
"space",
",",
"offset",
",",
"data",
",",
"extended",
")",
"raise",
"ValueError",
"(",
"'%s is not a valid size. Valid values are 8, 16, 32, or 64'",
"%",
"width",
")"
] |
Write in an 8-bit, 16-bit, 32-bit, 64-bit value to the specified memory space and offset.
Corresponds to viOut* functions of the VISA library.
:param session: Unique logical identifier to a session.
:param space: Specifies the address space. (Constants.*SPACE*)
:param offset: Offset (in bytes) of the address or register from which to read.
:param data: Data to write to bus.
:param width: Number of bits to read.
:param extended: Use 64 bits offset independent of the platform.
:return: return value of the library call.
:rtype: :class:`pyvisa.constants.StatusCode`
|
[
"Write",
"in",
"an",
"8",
"-",
"bit",
"16",
"-",
"bit",
"32",
"-",
"bit",
"64",
"-",
"bit",
"value",
"to",
"the",
"specified",
"memory",
"space",
"and",
"offset",
"."
] |
b8b2d4371e1f00782856aa9176ff1ced6bcb3798
|
https://github.com/pyvisa/pyvisa/blob/b8b2d4371e1f00782856aa9176ff1ced6bcb3798/pyvisa/highlevel.py#L250-L273
|
233,994
|
pyvisa/pyvisa
|
pyvisa/highlevel.py
|
VisaLibraryBase.peek
|
def peek(self, session, address, width):
"""Read an 8, 16, 32, or 64-bit value from the specified address.
Corresponds to viPeek* functions of the VISA library.
:param session: Unique logical identifier to a session.
:param address: Source address to read the value.
:param width: Number of bits to read.
:return: Data read from bus, return value of the library call.
:rtype: bytes, :class:`pyvisa.constants.StatusCode`
"""
if width == 8:
return self.peek_8(session, address)
elif width == 16:
return self.peek_16(session, address)
elif width == 32:
return self.peek_32(session, address)
elif width == 64:
return self.peek_64(session, address)
raise ValueError('%s is not a valid size. Valid values are 8, 16, 32 or 64' % width)
|
python
|
def peek(self, session, address, width):
"""Read an 8, 16, 32, or 64-bit value from the specified address.
Corresponds to viPeek* functions of the VISA library.
:param session: Unique logical identifier to a session.
:param address: Source address to read the value.
:param width: Number of bits to read.
:return: Data read from bus, return value of the library call.
:rtype: bytes, :class:`pyvisa.constants.StatusCode`
"""
if width == 8:
return self.peek_8(session, address)
elif width == 16:
return self.peek_16(session, address)
elif width == 32:
return self.peek_32(session, address)
elif width == 64:
return self.peek_64(session, address)
raise ValueError('%s is not a valid size. Valid values are 8, 16, 32 or 64' % width)
|
[
"def",
"peek",
"(",
"self",
",",
"session",
",",
"address",
",",
"width",
")",
":",
"if",
"width",
"==",
"8",
":",
"return",
"self",
".",
"peek_8",
"(",
"session",
",",
"address",
")",
"elif",
"width",
"==",
"16",
":",
"return",
"self",
".",
"peek_16",
"(",
"session",
",",
"address",
")",
"elif",
"width",
"==",
"32",
":",
"return",
"self",
".",
"peek_32",
"(",
"session",
",",
"address",
")",
"elif",
"width",
"==",
"64",
":",
"return",
"self",
".",
"peek_64",
"(",
"session",
",",
"address",
")",
"raise",
"ValueError",
"(",
"'%s is not a valid size. Valid values are 8, 16, 32 or 64'",
"%",
"width",
")"
] |
Read an 8, 16, 32, or 64-bit value from the specified address.
Corresponds to viPeek* functions of the VISA library.
:param session: Unique logical identifier to a session.
:param address: Source address to read the value.
:param width: Number of bits to read.
:return: Data read from bus, return value of the library call.
:rtype: bytes, :class:`pyvisa.constants.StatusCode`
|
[
"Read",
"an",
"8",
"16",
"32",
"or",
"64",
"-",
"bit",
"value",
"from",
"the",
"specified",
"address",
"."
] |
b8b2d4371e1f00782856aa9176ff1ced6bcb3798
|
https://github.com/pyvisa/pyvisa/blob/b8b2d4371e1f00782856aa9176ff1ced6bcb3798/pyvisa/highlevel.py#L328-L349
|
233,995
|
pyvisa/pyvisa
|
pyvisa/highlevel.py
|
VisaLibraryBase.poke
|
def poke(self, session, address, width, data):
"""Writes an 8, 16, 32, or 64-bit value from the specified address.
Corresponds to viPoke* functions of the VISA library.
:param session: Unique logical identifier to a session.
:param address: Source address to read the value.
:param width: Number of bits to read.
:param data: Data to be written to the bus.
:return: return value of the library call.
:rtype: :class:`pyvisa.constants.StatusCode`
"""
if width == 8:
return self.poke_8(session, address, data)
elif width == 16:
return self.poke_16(session, address, data)
elif width == 32:
return self.poke_32(session, address, data)
elif width == 64:
return self.poke_64(session, address, data)
raise ValueError('%s is not a valid size. Valid values are 8, 16, 32, or 64' % width)
|
python
|
def poke(self, session, address, width, data):
"""Writes an 8, 16, 32, or 64-bit value from the specified address.
Corresponds to viPoke* functions of the VISA library.
:param session: Unique logical identifier to a session.
:param address: Source address to read the value.
:param width: Number of bits to read.
:param data: Data to be written to the bus.
:return: return value of the library call.
:rtype: :class:`pyvisa.constants.StatusCode`
"""
if width == 8:
return self.poke_8(session, address, data)
elif width == 16:
return self.poke_16(session, address, data)
elif width == 32:
return self.poke_32(session, address, data)
elif width == 64:
return self.poke_64(session, address, data)
raise ValueError('%s is not a valid size. Valid values are 8, 16, 32, or 64' % width)
|
[
"def",
"poke",
"(",
"self",
",",
"session",
",",
"address",
",",
"width",
",",
"data",
")",
":",
"if",
"width",
"==",
"8",
":",
"return",
"self",
".",
"poke_8",
"(",
"session",
",",
"address",
",",
"data",
")",
"elif",
"width",
"==",
"16",
":",
"return",
"self",
".",
"poke_16",
"(",
"session",
",",
"address",
",",
"data",
")",
"elif",
"width",
"==",
"32",
":",
"return",
"self",
".",
"poke_32",
"(",
"session",
",",
"address",
",",
"data",
")",
"elif",
"width",
"==",
"64",
":",
"return",
"self",
".",
"poke_64",
"(",
"session",
",",
"address",
",",
"data",
")",
"raise",
"ValueError",
"(",
"'%s is not a valid size. Valid values are 8, 16, 32, or 64'",
"%",
"width",
")"
] |
Writes an 8, 16, 32, or 64-bit value from the specified address.
Corresponds to viPoke* functions of the VISA library.
:param session: Unique logical identifier to a session.
:param address: Source address to read the value.
:param width: Number of bits to read.
:param data: Data to be written to the bus.
:return: return value of the library call.
:rtype: :class:`pyvisa.constants.StatusCode`
|
[
"Writes",
"an",
"8",
"16",
"32",
"or",
"64",
"-",
"bit",
"value",
"from",
"the",
"specified",
"address",
"."
] |
b8b2d4371e1f00782856aa9176ff1ced6bcb3798
|
https://github.com/pyvisa/pyvisa/blob/b8b2d4371e1f00782856aa9176ff1ced6bcb3798/pyvisa/highlevel.py#L351-L373
|
233,996
|
pyvisa/pyvisa
|
pyvisa/highlevel.py
|
ResourceManager.close
|
def close(self):
"""Close the resource manager session.
"""
try:
logger.debug('Closing ResourceManager (session: %s)', self.session)
# Cleanly close all resources when closing the manager.
for resource in self._created_resources:
resource.close()
self.visalib.close(self.session)
self.session = None
self.visalib.resource_manager = None
except errors.InvalidSession:
pass
|
python
|
def close(self):
"""Close the resource manager session.
"""
try:
logger.debug('Closing ResourceManager (session: %s)', self.session)
# Cleanly close all resources when closing the manager.
for resource in self._created_resources:
resource.close()
self.visalib.close(self.session)
self.session = None
self.visalib.resource_manager = None
except errors.InvalidSession:
pass
|
[
"def",
"close",
"(",
"self",
")",
":",
"try",
":",
"logger",
".",
"debug",
"(",
"'Closing ResourceManager (session: %s)'",
",",
"self",
".",
"session",
")",
"# Cleanly close all resources when closing the manager.",
"for",
"resource",
"in",
"self",
".",
"_created_resources",
":",
"resource",
".",
"close",
"(",
")",
"self",
".",
"visalib",
".",
"close",
"(",
"self",
".",
"session",
")",
"self",
".",
"session",
"=",
"None",
"self",
".",
"visalib",
".",
"resource_manager",
"=",
"None",
"except",
"errors",
".",
"InvalidSession",
":",
"pass"
] |
Close the resource manager session.
|
[
"Close",
"the",
"resource",
"manager",
"session",
"."
] |
b8b2d4371e1f00782856aa9176ff1ced6bcb3798
|
https://github.com/pyvisa/pyvisa/blob/b8b2d4371e1f00782856aa9176ff1ced6bcb3798/pyvisa/highlevel.py#L1586-L1598
|
233,997
|
pyvisa/pyvisa
|
pyvisa/highlevel.py
|
ResourceManager.list_resources_info
|
def list_resources_info(self, query='?*::INSTR'):
"""Returns a dictionary mapping resource names to resource extended
information of all connected devices matching query.
For details of the VISA Resource Regular Expression syntax used in query,
refer to list_resources().
:param query: a VISA Resource Regular Expression used to match devices.
:return: Mapping of resource name to ResourceInfo
:rtype: dict[str, :class:`pyvisa.highlevel.ResourceInfo`]
"""
return dict((resource, self.resource_info(resource))
for resource in self.list_resources(query))
|
python
|
def list_resources_info(self, query='?*::INSTR'):
"""Returns a dictionary mapping resource names to resource extended
information of all connected devices matching query.
For details of the VISA Resource Regular Expression syntax used in query,
refer to list_resources().
:param query: a VISA Resource Regular Expression used to match devices.
:return: Mapping of resource name to ResourceInfo
:rtype: dict[str, :class:`pyvisa.highlevel.ResourceInfo`]
"""
return dict((resource, self.resource_info(resource))
for resource in self.list_resources(query))
|
[
"def",
"list_resources_info",
"(",
"self",
",",
"query",
"=",
"'?*::INSTR'",
")",
":",
"return",
"dict",
"(",
"(",
"resource",
",",
"self",
".",
"resource_info",
"(",
"resource",
")",
")",
"for",
"resource",
"in",
"self",
".",
"list_resources",
"(",
"query",
")",
")"
] |
Returns a dictionary mapping resource names to resource extended
information of all connected devices matching query.
For details of the VISA Resource Regular Expression syntax used in query,
refer to list_resources().
:param query: a VISA Resource Regular Expression used to match devices.
:return: Mapping of resource name to ResourceInfo
:rtype: dict[str, :class:`pyvisa.highlevel.ResourceInfo`]
|
[
"Returns",
"a",
"dictionary",
"mapping",
"resource",
"names",
"to",
"resource",
"extended",
"information",
"of",
"all",
"connected",
"devices",
"matching",
"query",
"."
] |
b8b2d4371e1f00782856aa9176ff1ced6bcb3798
|
https://github.com/pyvisa/pyvisa/blob/b8b2d4371e1f00782856aa9176ff1ced6bcb3798/pyvisa/highlevel.py#L1647-L1660
|
233,998
|
pyvisa/pyvisa
|
pyvisa/highlevel.py
|
ResourceManager.open_bare_resource
|
def open_bare_resource(self, resource_name,
access_mode=constants.AccessModes.no_lock,
open_timeout=constants.VI_TMO_IMMEDIATE):
"""Open the specified resource without wrapping into a class
:param resource_name: name or alias of the resource to open.
:param access_mode: access mode.
:type access_mode: :class:`pyvisa.constants.AccessModes`
:param open_timeout: time out to open.
:return: Unique logical identifier reference to a session.
"""
return self.visalib.open(self.session, resource_name, access_mode, open_timeout)
|
python
|
def open_bare_resource(self, resource_name,
access_mode=constants.AccessModes.no_lock,
open_timeout=constants.VI_TMO_IMMEDIATE):
"""Open the specified resource without wrapping into a class
:param resource_name: name or alias of the resource to open.
:param access_mode: access mode.
:type access_mode: :class:`pyvisa.constants.AccessModes`
:param open_timeout: time out to open.
:return: Unique logical identifier reference to a session.
"""
return self.visalib.open(self.session, resource_name, access_mode, open_timeout)
|
[
"def",
"open_bare_resource",
"(",
"self",
",",
"resource_name",
",",
"access_mode",
"=",
"constants",
".",
"AccessModes",
".",
"no_lock",
",",
"open_timeout",
"=",
"constants",
".",
"VI_TMO_IMMEDIATE",
")",
":",
"return",
"self",
".",
"visalib",
".",
"open",
"(",
"self",
".",
"session",
",",
"resource_name",
",",
"access_mode",
",",
"open_timeout",
")"
] |
Open the specified resource without wrapping into a class
:param resource_name: name or alias of the resource to open.
:param access_mode: access mode.
:type access_mode: :class:`pyvisa.constants.AccessModes`
:param open_timeout: time out to open.
:return: Unique logical identifier reference to a session.
|
[
"Open",
"the",
"specified",
"resource",
"without",
"wrapping",
"into",
"a",
"class"
] |
b8b2d4371e1f00782856aa9176ff1ced6bcb3798
|
https://github.com/pyvisa/pyvisa/blob/b8b2d4371e1f00782856aa9176ff1ced6bcb3798/pyvisa/highlevel.py#L1677-L1689
|
233,999
|
pyvisa/pyvisa
|
pyvisa/highlevel.py
|
ResourceManager.open_resource
|
def open_resource(self, resource_name,
access_mode=constants.AccessModes.no_lock,
open_timeout=constants.VI_TMO_IMMEDIATE,
resource_pyclass=None,
**kwargs):
"""Return an instrument for the resource name.
:param resource_name: name or alias of the resource to open.
:param access_mode: access mode.
:type access_mode: :class:`pyvisa.constants.AccessModes`
:param open_timeout: time out to open.
:param resource_pyclass: resource python class to use to instantiate the Resource.
Defaults to None: select based on the resource name.
:param kwargs: keyword arguments to be used to change instrument attributes
after construction.
:rtype: :class:`pyvisa.resources.Resource`
"""
if resource_pyclass is None:
info = self.resource_info(resource_name, extended=True)
try:
resource_pyclass = self._resource_classes[(info.interface_type, info.resource_class)]
except KeyError:
resource_pyclass = self._resource_classes[(constants.InterfaceType.unknown, '')]
logger.warning('There is no class defined for %r. Using Resource', (info.interface_type, info.resource_class))
res = resource_pyclass(self, resource_name)
for key in kwargs.keys():
try:
getattr(res, key)
present = True
except AttributeError:
present = False
except errors.InvalidSession:
present = True
if not present:
raise ValueError('%r is not a valid attribute for type %s' % (key, res.__class__.__name__))
res.open(access_mode, open_timeout)
self._created_resources.add(res)
for key, value in kwargs.items():
setattr(res, key, value)
return res
|
python
|
def open_resource(self, resource_name,
access_mode=constants.AccessModes.no_lock,
open_timeout=constants.VI_TMO_IMMEDIATE,
resource_pyclass=None,
**kwargs):
"""Return an instrument for the resource name.
:param resource_name: name or alias of the resource to open.
:param access_mode: access mode.
:type access_mode: :class:`pyvisa.constants.AccessModes`
:param open_timeout: time out to open.
:param resource_pyclass: resource python class to use to instantiate the Resource.
Defaults to None: select based on the resource name.
:param kwargs: keyword arguments to be used to change instrument attributes
after construction.
:rtype: :class:`pyvisa.resources.Resource`
"""
if resource_pyclass is None:
info = self.resource_info(resource_name, extended=True)
try:
resource_pyclass = self._resource_classes[(info.interface_type, info.resource_class)]
except KeyError:
resource_pyclass = self._resource_classes[(constants.InterfaceType.unknown, '')]
logger.warning('There is no class defined for %r. Using Resource', (info.interface_type, info.resource_class))
res = resource_pyclass(self, resource_name)
for key in kwargs.keys():
try:
getattr(res, key)
present = True
except AttributeError:
present = False
except errors.InvalidSession:
present = True
if not present:
raise ValueError('%r is not a valid attribute for type %s' % (key, res.__class__.__name__))
res.open(access_mode, open_timeout)
self._created_resources.add(res)
for key, value in kwargs.items():
setattr(res, key, value)
return res
|
[
"def",
"open_resource",
"(",
"self",
",",
"resource_name",
",",
"access_mode",
"=",
"constants",
".",
"AccessModes",
".",
"no_lock",
",",
"open_timeout",
"=",
"constants",
".",
"VI_TMO_IMMEDIATE",
",",
"resource_pyclass",
"=",
"None",
",",
"*",
"*",
"kwargs",
")",
":",
"if",
"resource_pyclass",
"is",
"None",
":",
"info",
"=",
"self",
".",
"resource_info",
"(",
"resource_name",
",",
"extended",
"=",
"True",
")",
"try",
":",
"resource_pyclass",
"=",
"self",
".",
"_resource_classes",
"[",
"(",
"info",
".",
"interface_type",
",",
"info",
".",
"resource_class",
")",
"]",
"except",
"KeyError",
":",
"resource_pyclass",
"=",
"self",
".",
"_resource_classes",
"[",
"(",
"constants",
".",
"InterfaceType",
".",
"unknown",
",",
"''",
")",
"]",
"logger",
".",
"warning",
"(",
"'There is no class defined for %r. Using Resource'",
",",
"(",
"info",
".",
"interface_type",
",",
"info",
".",
"resource_class",
")",
")",
"res",
"=",
"resource_pyclass",
"(",
"self",
",",
"resource_name",
")",
"for",
"key",
"in",
"kwargs",
".",
"keys",
"(",
")",
":",
"try",
":",
"getattr",
"(",
"res",
",",
"key",
")",
"present",
"=",
"True",
"except",
"AttributeError",
":",
"present",
"=",
"False",
"except",
"errors",
".",
"InvalidSession",
":",
"present",
"=",
"True",
"if",
"not",
"present",
":",
"raise",
"ValueError",
"(",
"'%r is not a valid attribute for type %s'",
"%",
"(",
"key",
",",
"res",
".",
"__class__",
".",
"__name__",
")",
")",
"res",
".",
"open",
"(",
"access_mode",
",",
"open_timeout",
")",
"self",
".",
"_created_resources",
".",
"add",
"(",
"res",
")",
"for",
"key",
",",
"value",
"in",
"kwargs",
".",
"items",
"(",
")",
":",
"setattr",
"(",
"res",
",",
"key",
",",
"value",
")",
"return",
"res"
] |
Return an instrument for the resource name.
:param resource_name: name or alias of the resource to open.
:param access_mode: access mode.
:type access_mode: :class:`pyvisa.constants.AccessModes`
:param open_timeout: time out to open.
:param resource_pyclass: resource python class to use to instantiate the Resource.
Defaults to None: select based on the resource name.
:param kwargs: keyword arguments to be used to change instrument attributes
after construction.
:rtype: :class:`pyvisa.resources.Resource`
|
[
"Return",
"an",
"instrument",
"for",
"the",
"resource",
"name",
"."
] |
b8b2d4371e1f00782856aa9176ff1ced6bcb3798
|
https://github.com/pyvisa/pyvisa/blob/b8b2d4371e1f00782856aa9176ff1ced6bcb3798/pyvisa/highlevel.py#L1691-L1739
|
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.