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... | 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... | [
"def",
"refresh_client",
"(",
"self",
",",
"from_dt",
"=",
"None",
",",
"to_dt",
"=",
"None",
")",
":",
"params_contacts",
"=",
"dict",
"(",
"self",
".",
"params",
")",
"params_contacts",
".",
"update",
"(",
"{",
"'clientVersion'",
":",
"'2.1'",
",",
"'l... | 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 authent... | 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 authent... | [
"def",
"authenticate",
"(",
"self",
")",
":",
"logger",
".",
"info",
"(",
"\"Authenticating as %s\"",
",",
"self",
".",
"user",
"[",
"'apple_id'",
"]",
")",
"data",
"=",
"dict",
"(",
"self",
".",
"user",
")",
"# We authenticate every time, so \"remember me\" is ... | 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",
"(",
")",... | 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
)
... | 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
)
... | [
"def",
"send_verification_code",
"(",
"self",
",",
"device",
")",
":",
"data",
"=",
"json",
".",
"dumps",
"(",
"device",
")",
"request",
"=",
"self",
".",
"session",
".",
"post",
"(",
"'%s/sendVerificationCode'",
"%",
"self",
".",
"_setup_endpoint",
",",
"... | 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(
... | 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(
... | [
"def",
"validate_verification_code",
"(",
"self",
",",
"device",
",",
"code",
")",
":",
"device",
".",
"update",
"(",
"{",
"'verificationCode'",
":",
"code",
",",
"'trustBrowser'",
":",
"True",
"}",
")",
"data",
"=",
"json",
".",
"dumps",
"(",
"device",
... | 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 ge... | 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 ge... | [
"def",
"send",
"(",
"r",
",",
"pool",
"=",
"None",
",",
"stream",
"=",
"False",
")",
":",
"if",
"pool",
"is",
"not",
"None",
":",
"return",
"pool",
".",
"spawn",
"(",
"r",
".",
"send",
",",
"stream",
"=",
"stream",
")",
"return",
"gevent",
".",
... | 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"... | 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 ... | 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 ... | [
"def",
"imap",
"(",
"requests",
",",
"stream",
"=",
"False",
",",
"size",
"=",
"2",
",",
"exception_handler",
"=",
"None",
")",
":",
"pool",
"=",
"Pool",
"(",
"size",
")",
"def",
"send",
"(",
"r",
")",
":",
"return",
"r",
".",
"send",
"(",
"strea... | 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_h... | [
"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... | 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... | [
"def",
"set_user_profile",
"(",
"self",
",",
"displayname",
"=",
"None",
",",
"avatar_url",
"=",
"None",
",",
"reason",
"=",
"\"Changing room profile information\"",
")",
":",
"member",
"=",
"self",
".",
"client",
".",
"api",
".",
"get_membership",
"(",
"self"... | 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_memb... | 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_memb... | [
"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",
... | 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(
... | 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(
... | [
"def",
"send_html",
"(",
"self",
",",
"html",
",",
"body",
"=",
"None",
",",
"msgtype",
"=",
"\"m.text\"",
")",
":",
"return",
"self",
".",
"client",
".",
"api",
".",
"send_message_event",
"(",
"self",
".",
"room_id",
",",
"\"m.room.message\"",
",",
"sel... | 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.
filei... | 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.
filei... | [
"def",
"send_file",
"(",
"self",
",",
"url",
",",
"name",
",",
"*",
"*",
"fileinfo",
")",
":",
"return",
"self",
".",
"client",
".",
"api",
".",
"send_content",
"(",
"self",
".",
"room_id",
",",
"url",
",",
"name",
",",
"\"m.file\"",
",",
"extra_info... | 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.
... | 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.
... | [
"def",
"send_image",
"(",
"self",
",",
"url",
",",
"name",
",",
"*",
"*",
"imageinfo",
")",
":",
"return",
"self",
".",
"client",
".",
"api",
".",
"send_content",
"(",
"self",
".",
"room_id",
",",
"url",
",",
"name",
",",
"\"m.image\"",
",",
"extra_i... | 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): Desc... | 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): Desc... | [
"def",
"send_location",
"(",
"self",
",",
"geo_uri",
",",
"name",
",",
"thumb_url",
"=",
"None",
",",
"*",
"*",
"thumb_info",
")",
":",
"return",
"self",
".",
"client",
".",
"api",
".",
"send_location",
"(",
"self",
".",
"room_id",
",",
"geo_uri",
",",... | 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 th... | [
"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.
... | 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.
... | [
"def",
"send_video",
"(",
"self",
",",
"url",
",",
"name",
",",
"*",
"*",
"videoinfo",
")",
":",
"return",
"self",
".",
"client",
".",
"api",
".",
"send_content",
"(",
"self",
".",
"room_id",
",",
"url",
",",
"name",
",",
"\"m.video\"",
",",
"extra_i... | 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.
... | 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.
... | [
"def",
"send_audio",
"(",
"self",
",",
"url",
",",
"name",
",",
"*",
"*",
"audioinfo",
")",
":",
"return",
"self",
".",
"client",
".",
"api",
".",
"send_content",
"(",
"self",
".",
"room_id",
",",
"url",
",",
"name",
",",
"\"m.audio\"",
",",
"extra_i... | 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 i... | 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 i... | [
"def",
"add_listener",
"(",
"self",
",",
"callback",
",",
"event_type",
"=",
"None",
")",
":",
"listener_id",
"=",
"uuid4",
"(",
")",
"self",
".",
"listeners",
".",
"append",
"(",
"{",
"'uid'",
":",
"listener_id",
",",
"'callback'",
":",
"callback",
",",... | 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:
... | 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:
... | [
"def",
"add_ephemeral_listener",
"(",
"self",
",",
"callback",
",",
"event_type",
"=",
"None",
")",
":",
"listener_id",
"=",
"uuid4",
"(",
")",
"self",
".",
"ephemeral_listeners",
".",
"append",
"(",
"{",
"'uid'",
":",
"listener_id",
",",
"'callback'",
":",
... | 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... | [
"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.cli... | 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.cli... | [
"def",
"kick_user",
"(",
"self",
",",
"user_id",
",",
"reason",
"=",
"\"\"",
")",
":",
"try",
":",
"self",
".",
"client",
".",
"api",
".",
"kick_user",
"(",
"self",
".",
"room_id",
",",
"user_id",
")",
"return",
"True",
"except",
"MatrixRequestError",
... | 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 ... | 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 ... | [
"def",
"leave",
"(",
"self",
")",
":",
"try",
":",
"self",
".",
"client",
".",
"api",
".",
"leave_room",
"(",
"self",
".",
"room_id",
")",
"del",
"self",
".",
"client",
".",
"rooms",
"[",
"self",
".",
"room_id",
"]",
"return",
"True",
"except",
"Ma... | 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 ... | 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 ... | [
"def",
"update_room_name",
"(",
"self",
")",
":",
"try",
":",
"response",
"=",
"self",
".",
"client",
".",
"api",
".",
"get_room_name",
"(",
"self",
".",
"room_id",
")",
"if",
"\"name\"",
"in",
"response",
"and",
"response",
"[",
"\"name\"",
"]",
"!=",
... | 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",
"MatrixRequest... | 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 identif... | 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 identif... | [
"def",
"send_state_event",
"(",
"self",
",",
"event_type",
",",
"content",
",",
"state_key",
"=",
"\"\"",
")",
":",
"return",
"self",
".",
"client",
".",
"api",
".",
"send_state_event",
"(",
"self",
".",
"room_id",
",",
"event_type",
",",
"content",
",",
... | 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"]
... | 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"]
... | [
"def",
"update_room_topic",
"(",
"self",
")",
":",
"try",
":",
"response",
"=",
"self",
".",
"client",
".",
"api",
".",
"get_room_topic",
"(",
"self",
".",
"room_id",
")",
"if",
"\"topic\"",
"in",
"response",
"and",
"response",
"[",
"\"topic\"",
"]",
"!=... | 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:
... | 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:
... | [
"def",
"set_room_topic",
"(",
"self",
",",
"topic",
")",
":",
"try",
":",
"self",
".",
"client",
".",
"api",
".",
"set_room_topic",
"(",
"self",
".",
"room_id",
",",
"topic",
")",
"self",
".",
"topic",
"=",
"topic",
"return",
"True",
"except",
"MatrixR... | 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 c... | 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 c... | [
"def",
"update_aliases",
"(",
"self",
")",
":",
"try",
":",
"response",
"=",
"self",
".",
"client",
".",
"api",
".",
"get_room_state",
"(",
"self",
".",
"room_id",
")",
"for",
"chunk",
"in",
"response",
":",
"if",
"\"content\"",
"in",
"chunk",
"and",
"... | 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",
"... | 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 (... | 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 (... | [
"def",
"backfill_previous_messages",
"(",
"self",
",",
"reverse",
"=",
"False",
",",
"limit",
"=",
"10",
")",
":",
"res",
"=",
"self",
".",
"client",
".",
"api",
".",
"get_room_messages",
"(",
"self",
".",
"room_id",
",",
"self",
".",
"prev_batch",
",",
... | 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 leve... | 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 leve... | [
"def",
"modify_user_power_levels",
"(",
"self",
",",
"users",
"=",
"None",
",",
"users_default",
"=",
"None",
")",
":",
"try",
":",
"content",
"=",
"self",
".",
"client",
".",
"api",
".",
"get_power_levels",
"(",
"self",
".",
"room_id",
")",
"if",
"users... | 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 spe... | [
"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 eve... | 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 eve... | [
"def",
"modify_required_power_levels",
"(",
"self",
",",
"events",
"=",
"None",
",",
"*",
"*",
"kwargs",
")",
":",
"try",
":",
"content",
"=",
"self",
".",
"client",
".",
"api",
".",
"get_power_levels",
"(",
"self",
".",
"room_id",
")",
"content",
".",
... | 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 ... | [
"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
... | 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
... | [
"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"... | 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_guest... | 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_guest... | [
"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",
",",... | 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": "... | 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": "... | [
"def",
"enable_encryption",
"(",
"self",
")",
":",
"try",
":",
"self",
".",
"send_state_event",
"(",
"\"m.room.encryption\"",
",",
"{",
"\"algorithm\"",
":",
"\"m.megolm.v1.aes-sha2\"",
"}",
")",
"self",
".",
"encrypted",
"=",
"True",
"return",
"True",
"except",... | 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)
toke... | 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)
toke... | [
"def",
"example",
"(",
"host",
",",
"user",
",",
"password",
",",
"token",
")",
":",
"client",
"=",
"None",
"try",
":",
"if",
"token",
":",
"print",
"(",
"'token login'",
")",
"client",
"=",
"MatrixClient",
"(",
"host",
",",
"token",
"=",
"token",
",... | 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()
i... | 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()
i... | [
"def",
"main",
"(",
")",
":",
"parser",
"=",
"argparse",
".",
"ArgumentParser",
"(",
")",
"parser",
".",
"add_argument",
"(",
"\"--host\"",
",",
"type",
"=",
"str",
",",
"required",
"=",
"True",
")",
"parser",
".",
"add_argument",
"(",
"\"--user\"",
",",... | 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 wai... | 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 wai... | [
"def",
"sync",
"(",
"self",
",",
"since",
"=",
"None",
",",
"timeout_ms",
"=",
"30000",
",",
"filter",
"=",
"None",
",",
"full_state",
"=",
"None",
",",
"set_presence",
"=",
"None",
")",
":",
"request",
"=",
"{",
"# non-integer timeouts appear to cause issue... | 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 sta... | [
"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 ... | 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 ... | [
"def",
"send_location",
"(",
"self",
",",
"room_id",
",",
"geo_uri",
",",
"name",
",",
"thumb_url",
"=",
"None",
",",
"thumb_info",
"=",
"None",
",",
"timestamp",
"=",
"None",
")",
":",
"content_pack",
"=",
"{",
"\"geo_uri\"",
":",
"geo_uri",
",",
"\"msg... | 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 (dic... | [
"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
... | 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
... | [
"def",
"media_download",
"(",
"self",
",",
"mxcurl",
",",
"allow_remote",
"=",
"True",
")",
":",
"query_params",
"=",
"{",
"}",
"if",
"not",
"allow_remote",
":",
"query_params",
"[",
"\"allow_remote\"",
"]",
"=",
"False",
"if",
"mxcurl",
".",
"startswith",
... | 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 ... | 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 ... | [
"def",
"get_thumbnail",
"(",
"self",
",",
"mxcurl",
",",
"width",
",",
"height",
",",
"method",
"=",
"'scale'",
",",
"allow_remote",
"=",
"True",
")",
":",
"if",
"method",
"not",
"in",
"[",
"'scale'",
",",
"'crop'",
"]",
":",
"raise",
"ValueError",
"("... | 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'.
... | [
"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
... | 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
... | [
"def",
"get_url_preview",
"(",
"self",
",",
"url",
",",
"ts",
"=",
"None",
")",
":",
"params",
"=",
"{",
"'url'",
":",
"url",
"}",
"if",
"ts",
":",
"params",
"[",
"'ts'",
"]",
"=",
"ts",
"return",
"self",
".",
"_send",
"(",
"\"GET\"",
",",
"\"\""... | 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"... | 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"... | [
"def",
"get_room_id",
"(",
"self",
",",
"room_alias",
")",
":",
"content",
"=",
"self",
".",
"_send",
"(",
"\"GET\"",
",",
"\"/directory/room/{}\"",
".",
"format",
"(",
"quote",
"(",
"room_alias",
")",
")",
")",
"return",
"content",
".",
"get",
"(",
"\"r... | 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/{}".for... | 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/{}".for... | [
"def",
"set_room_alias",
"(",
"self",
",",
"room_id",
",",
"room_alias",
")",
":",
"data",
"=",
"{",
"\"room_id\"",
":",
"room_id",
"}",
"return",
"self",
".",
"_send",
"(",
"\"PUT\"",
",",
"\"/directory/room/{}\"",
".",
"format",
"(",
"quote",
"(",
"room_... | 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 = {
... | 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 = {
... | [
"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 = {
... | 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 = {
... | [
"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_n... | 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_n... | [
"def",
"update_device_info",
"(",
"self",
",",
"device_id",
",",
"display_name",
")",
":",
"content",
"=",
"{",
"\"display_name\"",
":",
"display_name",
"}",
"return",
"self",
".",
"_send",
"(",
"\"PUT\"",
",",
"\"/devices/%s\"",
"%",
"device_id",
",",
"conten... | 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 ... | 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 ... | [
"def",
"delete_device",
"(",
"self",
",",
"auth_body",
",",
"device_id",
")",
":",
"content",
"=",
"{",
"\"auth\"",
":",
"auth_body",
"}",
"return",
"self",
".",
"_send",
"(",
"\"DELETE\"",
",",
"\"/devices/%s\"",
"%",
"device_id",
",",
"content",
"=",
"co... | 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 = {
... | 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 = {
... | [
"def",
"delete_devices",
"(",
"self",
",",
"auth_body",
",",
"devices",
")",
":",
"content",
"=",
"{",
"\"auth\"",
":",
"auth_body",
",",
"\"devices\"",
":",
"devices",
"}",
"return",
"self",
".",
"_send",
"(",
"\"POST\"",
",",
"\"/delete_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. | [
"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:
... | 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:
... | [
"def",
"upload_keys",
"(",
"self",
",",
"device_keys",
"=",
"None",
",",
"one_time_keys",
"=",
"None",
")",
":",
"content",
"=",
"{",
"}",
"if",
"device_keys",
":",
"content",
"[",
"\"device_keys\"",
"]",
"=",
"device_keys",
"if",
"one_time_keys",
":",
"co... | 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 m... | [
"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
a... | 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
a... | [
"def",
"query_keys",
"(",
"self",
",",
"user_devices",
",",
"timeout",
"=",
"None",
",",
"token",
"=",
"None",
")",
":",
"content",
"=",
"{",
"\"device_keys\"",
":",
"user_devices",
"}",
"if",
"timeout",
":",
"content",
"[",
"\"timeout\"",
"]",
"=",
"tim... | 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): Optiona... | [
"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) t... | 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) t... | [
"def",
"claim_keys",
"(",
"self",
",",
"key_request",
",",
"timeout",
"=",
"None",
")",
":",
"content",
"=",
"{",
"\"one_time_keys\"",
":",
"key_request",
"}",
"if",
"timeout",
":",
"content",
"[",
"\"timeout\"",
"]",
"=",
"timeout",
"return",
"self",
".",... | 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 ser... | [
"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 (st... | 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 (st... | [
"def",
"key_changes",
"(",
"self",
",",
"from_token",
",",
"to_token",
")",
":",
"params",
"=",
"{",
"\"from\"",
":",
"from_token",
",",
"\"to\"",
":",
"to_token",
"}",
"return",
"self",
".",
"_send",
"(",
"\"GET\"",
",",
"\"/keys/changes\"",
",",
"query_p... | 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 nex... | [
"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_cont... | 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_cont... | [
"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\"",
",",
... | 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 ... | [
"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
"""
... | 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
"""
... | [
"def",
"register_with_password",
"(",
"self",
",",
"username",
",",
"password",
")",
":",
"response",
"=",
"self",
".",
"api",
".",
"register",
"(",
"auth_body",
"=",
"{",
"\"type\"",
":",
"\"m.login.dummy\"",
"}",
",",
"kind",
"=",
"'user'",
",",
"usernam... | 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:... | 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:... | [
"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",
",",
... | 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 retur... | 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 retur... | [
"def",
"login_with_password",
"(",
"self",
",",
"username",
",",
"password",
",",
"limit",
"=",
"10",
")",
":",
"warn",
"(",
"\"login_with_password is deprecated. Use login with sync=True.\"",
",",
"DeprecationWarning",
")",
"return",
"self",
".",
"login",
"(",
"use... | 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... | [
"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 ... | 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 ... | [
"def",
"login",
"(",
"self",
",",
"username",
",",
"password",
",",
"limit",
"=",
"10",
",",
"sync",
"=",
"True",
",",
"device_id",
"=",
"None",
")",
":",
"response",
"=",
"self",
".",
"api",
".",
"login",
"(",
"\"m.login.password\"",
",",
"user",
"=... | 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. Wh... | [
"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... | 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... | [
"def",
"create_room",
"(",
"self",
",",
"alias",
"=",
"None",
",",
"is_public",
"=",
"False",
",",
"invitees",
"=",
"None",
")",
":",
"response",
"=",
"self",
".",
"api",
".",
"create_room",
"(",
"alias",
"=",
"alias",
",",
"is_public",
"=",
"is_public... | 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:
... | [
"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:
... | 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:
... | [
"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(Liste... | 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... | [
"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 li... | 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 li... | [
"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)):... | 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)):... | [
"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",
"(",
"s... | 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
thr... | [
"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 ... | 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 ... | [
"def",
"start_listener_thread",
"(",
"self",
",",
"timeout_ms",
"=",
"30000",
",",
"exception_handler",
"=",
"None",
")",
":",
"try",
":",
"thread",
"=",
"Thread",
"(",
"target",
"=",
"self",
".",
"listen_forever",
",",
"args",
"=",
"(",
"timeout_ms",
",",... | 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... | [
"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.
... | 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.
... | [
"def",
"upload",
"(",
"self",
",",
"content",
",",
"content_type",
",",
"filename",
"=",
"None",
")",
":",
"try",
":",
"response",
"=",
"self",
".",
"api",
".",
"media_upload",
"(",
"content",
",",
"content_type",
",",
"filename",
")",
"if",
"\"content_u... | 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 homeserv... | [
"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)
r... | 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)
r... | [
"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... | 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... | [
"def",
"upload_identity_keys",
"(",
"self",
")",
":",
"device_keys",
"=",
"{",
"'user_id'",
":",
"self",
".",
"user_id",
",",
"'device_id'",
":",
"self",
".",
"device_id",
",",
"'algorithms'",
":",
"self",
".",
"_algorithms",
",",
"'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
no... | 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
no... | [
"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",
"(",
")",
"[",... | 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.
... | [
"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_key... | 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_key... | [
"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",
"(",
"... | 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:
... | 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:
... | [
"def",
"sign_json",
"(",
"self",
",",
"json",
")",
":",
"signatures",
"=",
"json",
".",
"pop",
"(",
"'signatures'",
",",
"{",
"}",
")",
"unsigned",
"=",
"json",
".",
"pop",
"(",
"'unsigned'",
",",
"None",
")",
"signature_base64",
"=",
"self",
".",
"o... | 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 si... | [
"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.
us... | 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.
us... | [
"def",
"verify_json",
"(",
"self",
",",
"json",
",",
"user_key",
",",
"user_id",
",",
"device_id",
")",
":",
"try",
":",
"signatures",
"=",
"json",
".",
"pop",
"(",
"'signatures'",
")",
"except",
"KeyError",
":",
"return",
"False",
"key_id",
"=",
"'ed255... | 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... | [
"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 r... | 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 r... | [
"def",
"get_display_name",
"(",
"self",
",",
"room",
"=",
"None",
")",
":",
"if",
"room",
":",
"try",
":",
"return",
"room",
".",
"members_displaynames",
"[",
"self",
".",
"user_id",
"]",
"except",
"KeyError",
":",
"return",
"self",
".",
"user_id",
"if",... | 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 ... | 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 ... | [
"def",
"prepare_encrypted_request",
"(",
"self",
",",
"session",
",",
"endpoint",
",",
"message",
")",
":",
"host",
"=",
"urlsplit",
"(",
"endpoint",
")",
".",
"hostname",
"if",
"self",
".",
"protocol",
"==",
"'credssp'",
"and",
"len",
"(",
"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
... | [
"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']... | 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']... | [
"def",
"parse_encrypted_response",
"(",
"self",
",",
"response",
")",
":",
"content_type",
"=",
"response",
".",
"headers",
"[",
"'Content-Type'",
"]",
"if",
"'protocol=\"{0}\"'",
".",
"format",
"(",
"self",
".",
"protocol_string",
".",
"decode",
"(",
")",
")"... | 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... | 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... | [
"def",
"open_shell",
"(",
"self",
",",
"i_stream",
"=",
"'stdin'",
",",
"o_stream",
"=",
"'stdout stderr'",
",",
"working_directory",
"=",
"None",
",",
"env_vars",
"=",
"None",
",",
"noprofile",
"=",
"False",
",",
"codepage",
"=",
"437",
",",
"lifetime",
"... | 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... | [
"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.uui... | 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.uui... | [
"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/... | 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: Th... | 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: Th... | [
"def",
"run_command",
"(",
"self",
",",
"shell_id",
",",
"command",
",",
"arguments",
"=",
"(",
")",
",",
"console_mode_stdin",
"=",
"True",
",",
"skip_cmd_shell",
"=",
"False",
")",
":",
"req",
"=",
"{",
"'env:Envelope'",
":",
"self",
".",
"_get_soap_head... | 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 b... | [
"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
#@r... | 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
#@r... | [
"def",
"get_command_output",
"(",
"self",
",",
"shell_id",
",",
"command_id",
")",
":",
"stdout_buffer",
",",
"stderr_buffer",
"=",
"[",
"]",
",",
"[",
"]",
"command_done",
"=",
"False",
"while",
"not",
"command_done",
":",
"try",
":",
"stdout",
",",
"stde... | 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.
Dat... | [
"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 -encodedcomman... | 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 -encodedcomman... | [
"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_c... | 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 t... | 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 t... | [
"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 CLIXM... | 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",
... | 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',
... | 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',
... | [
"def",
"return_handler",
"(",
"module_logger",
",",
"first_is_session",
"=",
"True",
")",
":",
"def",
"_outer",
"(",
"visa_library_method",
")",
":",
"def",
"_inner",
"(",
"self",
",",
"session",
",",
"*",
"args",
",",
"*",
"*",
"kwargs",
")",
":",
"ret_... | 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('p... | 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('p... | [
"def",
"list_backends",
"(",
")",
":",
"return",
"[",
"'ni'",
"]",
"+",
"[",
"name",
"for",
"(",
"loader",
",",
"name",
",",
"ispkg",
")",
"in",
"pkgutil",
".",
"iter_modules",
"(",
")",
"if",
"name",
".",
"startswith",
"(",
"'pyvisa-'",
")",
"and",
... | 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... | 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... | [
"def",
"get_wrapper_class",
"(",
"backend_name",
")",
":",
"try",
":",
"return",
"_WRAPPERS",
"[",
"backend_name",
"]",
"except",
"KeyError",
":",
"if",
"backend_name",
"==",
"'ni'",
":",
"from",
".",
"ctwrapper",
"import",
"NIVisaLibrary",
"_WRAPPERS",
"[",
"... | 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 ... | 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 ... | [
"def",
"open_visa_library",
"(",
"specification",
")",
":",
"if",
"not",
"specification",
":",
"logger",
".",
"debug",
"(",
"'No visa library specified, trying to find alternatives.'",
")",
"try",
":",
"specification",
"=",
"os",
".",
"environ",
"[",
"'PYVISA_LIBRARY'... | 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 v... | 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 v... | [
"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... | 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[sessi... | 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[sessi... | [
"def",
"ignore_warning",
"(",
"self",
",",
"session",
",",
"*",
"warnings_constants",
")",
":",
"self",
".",
"_ignore_warning_in_session",
"[",
"session",
"]",
".",
"update",
"(",
"warnings_constants",
")",
"yield",
"self",
".",
"_ignore_warning_in_session",
"[",
... | 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_hel... | 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_hel... | [
"def",
"uninstall_all_visa_handlers",
"(",
"self",
",",
"session",
")",
":",
"if",
"session",
"is",
"not",
"None",
":",
"self",
".",
"__uninstall_all_handlers_helper",
"(",
"session",
")",
"else",
":",
"for",
"session",
"in",
"list",
"(",
"self",
".",
"handl... | 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 ... | 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 ... | [
"def",
"write_memory",
"(",
"self",
",",
"session",
",",
"space",
",",
"offset",
",",
"data",
",",
"width",
",",
"extended",
"=",
"False",
")",
":",
"if",
"width",
"==",
"8",
":",
"return",
"self",
".",
"out_8",
"(",
"session",
",",
"space",
",",
"... | 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 (i... | [
"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 widt... | 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 widt... | [
"def",
"peek",
"(",
"self",
",",
"session",
",",
"address",
",",
"width",
")",
":",
"if",
"width",
"==",
"8",
":",
"return",
"self",
".",
"peek_8",
"(",
"session",
",",
"address",
")",
"elif",
"width",
"==",
"16",
":",
"return",
"self",
".",
"peek_... | 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 rea... | [
"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.
:pa... | 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.
:pa... | [
"def",
"poke",
"(",
"self",
",",
"session",
",",
"address",
",",
"width",
",",
"data",
")",
":",
"if",
"width",
"==",
"8",
":",
"return",
"self",
".",
"poke_8",
"(",
"session",
",",
"address",
",",
"data",
")",
"elif",
"width",
"==",
"16",
":",
"... | 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: Da... | [
"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... | 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... | [
"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_reso... | 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... | 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... | [
"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 devi... | [
"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.
... | 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.
... | [
"def",
"open_bare_resource",
"(",
"self",
",",
"resource_name",
",",
"access_mode",
"=",
"constants",
".",
"AccessModes",
".",
"no_lock",
",",
"open_timeout",
"=",
"constants",
".",
"VI_TMO_IMMEDIATE",
")",
":",
"return",
"self",
".",
"visalib",
".",
"open",
"... | 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 identi... | [
"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 reso... | 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 reso... | [
"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 clas... | [
"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.