1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612
|
# pyright: strict
import datetime
import json
from copy import deepcopy
from typing_extensions import TYPE_CHECKING, Type, Literal, Self
from typing import (
Any,
Dict,
List,
Optional,
Mapping,
Set,
Tuple,
ClassVar,
Union,
cast,
overload,
)
# Used to break circular imports
import stripe # noqa: IMP101
from stripe import _util
from stripe._stripe_response import (
StripeResponse,
StripeStreamResponse,
StripeStreamResponseAsync,
)
from stripe._encode import _encode_datetime # pyright: ignore
from stripe._request_options import extract_options_from_dict
from stripe._api_mode import ApiMode
from stripe._base_address import BaseAddress
if TYPE_CHECKING:
from stripe import _APIRequestor # pyright: ignore[reportPrivateUsage]
@overload
def _compute_diff(
current: Dict[str, Any], previous: Optional[Dict[str, Any]]
) -> Dict[str, Any]: ...
@overload
def _compute_diff(
current: object, previous: Optional[Dict[str, Any]]
) -> object: ...
def _compute_diff(
current: object, previous: Optional[Dict[str, Any]]
) -> object:
if isinstance(current, dict):
current = cast(Dict[str, Any], current)
previous = previous or {}
diff = current.copy()
for key in set(previous.keys()) - set(diff.keys()):
diff[key] = ""
return diff
return current if current is not None else ""
def _serialize_list(
array: Optional[List[Any]], previous: List[Any]
) -> Dict[str, Any]:
array = array or []
previous = previous or []
params: Dict[str, Any] = {}
for i, v in enumerate(array):
previous_item = previous[i] if len(previous) > i else None
if hasattr(v, "serialize"):
params[str(i)] = v.serialize(previous_item)
else:
params[str(i)] = _compute_diff(v, previous_item)
return params
class StripeObject(Dict[str, Any]):
class _ReprJSONEncoder(json.JSONEncoder):
def default(self, o: Any) -> Any:
if isinstance(o, datetime.datetime):
return _encode_datetime(o)
return super(StripeObject._ReprJSONEncoder, self).default(o)
_retrieve_params: Mapping[str, Any]
_previous: Optional[Mapping[str, Any]]
def __init__(
self,
id: Optional[str] = None,
api_key: Optional[str] = None,
stripe_version: Optional[str] = None,
stripe_account: Optional[str] = None,
last_response: Optional[StripeResponse] = None,
*,
_requestor: Optional["_APIRequestor"] = None,
# TODO: is a more specific type possible here?
**params: Any,
):
super(StripeObject, self).__init__()
self._unsaved_values: Set[str] = set()
self._transient_values: Set[str] = set()
self._last_response = last_response
self._retrieve_params = params
self._previous = None
self._requestor = (
stripe._APIRequestor._global_with_options( # pyright: ignore[reportPrivateUsage]
api_key=api_key,
stripe_version=stripe_version,
stripe_account=stripe_account,
)
if _requestor is None
else _requestor
)
if id:
self["id"] = id
@property
def api_key(self):
return self._requestor.api_key
@property
def stripe_account(self):
return self._requestor.stripe_account
@property
def stripe_version(self):
return self._requestor.stripe_version
@property
def last_response(self) -> Optional[StripeResponse]:
return self._last_response
# StripeObject inherits from `dict` which has an update method, and this doesn't quite match
# the full signature of the update method in MutableMapping. But we ignore.
def update( # pyright: ignore
self, update_dict: Mapping[str, Any]
) -> None:
for k in update_dict:
self._unsaved_values.add(k)
return super(StripeObject, self).update(update_dict)
if not TYPE_CHECKING:
def __setattr__(self, k, v):
if k in {"api_key", "stripe_account", "stripe_version"}:
self._requestor = self._requestor._replace_options({k: v})
return None
if k[0] == "_" or k in self.__dict__:
return super(StripeObject, self).__setattr__(k, v)
self[k] = v
return None
def __getattr__(self, k):
if k[0] == "_":
raise AttributeError(k)
try:
if k in self._field_remappings:
k = self._field_remappings[k]
return self[k]
except KeyError as err:
raise AttributeError(*err.args) from err
def __delattr__(self, k):
if k[0] == "_" or k in self.__dict__:
return super(StripeObject, self).__delattr__(k)
else:
del self[k]
def __setitem__(self, k: str, v: Any) -> None:
if v == "":
raise ValueError(
"You cannot set %s to an empty string on this object. "
"The empty string is treated specially in our requests. "
"If you'd like to delete the property using the save() method on this object, you may set %s.%s=None. "
"Alternatively, you can pass %s='' to delete the property when using a resource method such as modify()."
% (k, str(self), k, k)
)
# Allows for unpickling in Python 3.x
if not hasattr(self, "_unsaved_values"):
self._unsaved_values = set()
self._unsaved_values.add(k)
super(StripeObject, self).__setitem__(k, v)
def __getitem__(self, k: str) -> Any:
try:
return super(StripeObject, self).__getitem__(k)
except KeyError as err:
if k in self._transient_values:
raise KeyError(
"%r. HINT: The %r attribute was set in the past."
"It was then wiped when refreshing the object with "
"the result returned by Stripe's API, probably as a "
"result of a save(). The attributes currently "
"available on this object are: %s"
% (k, k, ", ".join(list(self.keys())))
)
else:
raise err
def __delitem__(self, k: str) -> None:
super(StripeObject, self).__delitem__(k)
# Allows for unpickling in Python 3.x
if hasattr(self, "_unsaved_values") and k in self._unsaved_values:
self._unsaved_values.remove(k)
# Custom unpickling method that uses `update` to update the dictionary
# without calling __setitem__, which would fail if any value is an empty
# string
def __setstate__(self, state: Dict[str, Any]) -> None:
self.update(state)
# Custom pickling method to ensure the instance is pickled as a custom
# class and not as a dict, otherwise __setstate__ would not be called when
# unpickling.
def __reduce__(self) -> Tuple[Any, ...]:
reduce_value = (
type(self), # callable
( # args
self.get("id", None),
self.api_key,
self.stripe_version,
self.stripe_account,
),
dict(self), # state
)
return reduce_value
@classmethod
def construct_from(
cls,
values: Dict[str, Any],
key: Optional[str],
stripe_version: Optional[str] = None,
stripe_account: Optional[str] = None,
last_response: Optional[StripeResponse] = None,
*,
api_mode: ApiMode = "V1",
) -> Self:
return cls._construct_from(
values=values,
requestor=stripe._APIRequestor._global_with_options( # pyright: ignore[reportPrivateUsage]
api_key=key,
stripe_version=stripe_version,
stripe_account=stripe_account,
),
api_mode=api_mode,
last_response=last_response,
)
@classmethod
def _construct_from(
cls,
*,
values: Dict[str, Any],
last_response: Optional[StripeResponse] = None,
requestor: "_APIRequestor",
api_mode: ApiMode,
) -> Self:
instance = cls(
values.get("id"),
last_response=last_response,
_requestor=requestor,
)
instance._refresh_from(
values=values,
last_response=last_response,
requestor=requestor,
api_mode=api_mode,
)
return instance
def refresh_from(
self,
values: Dict[str, Any],
api_key: Optional[str] = None,
partial: Optional[bool] = False,
stripe_version: Optional[str] = None,
stripe_account: Optional[str] = None,
last_response: Optional[StripeResponse] = None,
*,
api_mode: ApiMode = "V1",
) -> None:
self._refresh_from(
values=values,
partial=partial,
last_response=last_response,
requestor=self._requestor._replace_options( # pyright: ignore[reportPrivateUsage]
{
"api_key": api_key,
"stripe_version": stripe_version,
"stripe_account": stripe_account,
}
),
api_mode=api_mode,
)
def _refresh_from(
self,
*,
values: Dict[str, Any],
partial: Optional[bool] = False,
last_response: Optional[StripeResponse] = None,
requestor: Optional["_APIRequestor"] = None,
api_mode: ApiMode,
) -> None:
self._requestor = requestor or self._requestor
self._last_response = last_response or getattr(
values, "_last_response", None
)
# Wipe old state before setting new. This is useful for e.g.
# updating a customer, where there is no persistent card
# parameter. Mark those values which don't persist as transient
if partial:
self._unsaved_values = self._unsaved_values - set(values)
else:
removed = set(self.keys()) - set(values)
self._transient_values = self._transient_values | removed
self._unsaved_values = set()
self.clear()
self._transient_values = self._transient_values - set(values)
for k, v in values.items():
inner_class = self._get_inner_class_type(k)
is_dict = self._get_inner_class_is_beneath_dict(k)
if is_dict:
obj = {
k: None
if v is None
else cast(
StripeObject,
_util._convert_to_stripe_object( # pyright: ignore[reportPrivateUsage]
resp=v,
params=None,
klass_=inner_class,
requestor=self._requestor,
api_mode=api_mode,
),
)
for k, v in v.items()
}
else:
obj = cast(
Union[StripeObject, List[StripeObject]],
_util._convert_to_stripe_object( # pyright: ignore[reportPrivateUsage]
resp=v,
params=None,
klass_=inner_class,
requestor=self._requestor,
api_mode=api_mode,
),
)
super(StripeObject, self).__setitem__(k, obj)
self._previous = values
@_util.deprecated(
"This will be removed in a future version of stripe-python."
)
def request(
self,
method: Literal["get", "post", "delete"],
url: str,
params: Optional[Dict[str, Any]] = None,
*,
base_address: BaseAddress = "api",
) -> "StripeObject":
return StripeObject._request(
self,
method,
url,
params=params,
base_address=base_address,
)
def _request(
self,
method: Literal["get", "post", "delete"],
url: str,
params: Optional[Mapping[str, Any]] = None,
usage: Optional[List[str]] = None,
*,
base_address: BaseAddress,
) -> "StripeObject":
if params is None:
params = self._retrieve_params
request_options, request_params = extract_options_from_dict(params)
return self._requestor.request(
method,
url,
params=request_params,
options=request_options,
base_address=base_address,
usage=usage,
)
async def _request_async(
self,
method: Literal["get", "post", "delete"],
url: str,
params: Optional[Mapping[str, Any]] = None,
usage: Optional[List[str]] = None,
*,
base_address: BaseAddress,
) -> "StripeObject":
if params is None:
params = self._retrieve_params
request_options, request_params = extract_options_from_dict(params)
return await self._requestor.request_async(
method,
url,
params=request_params,
options=request_options,
base_address=base_address,
usage=usage,
)
def _request_stream(
self,
method: str,
url: str,
params: Optional[Mapping[str, Any]] = None,
*,
base_address: BaseAddress = "api",
) -> StripeStreamResponse:
if params is None:
params = self._retrieve_params
request_options, request_params = extract_options_from_dict(params)
return self._requestor.request_stream(
method,
url,
params=request_params,
options=request_options,
base_address=base_address,
)
async def _request_stream_async(
self,
method: str,
url: str,
params: Optional[Mapping[str, Any]] = None,
*,
base_address: BaseAddress = "api",
) -> StripeStreamResponseAsync:
if params is None:
params = self._retrieve_params
request_options, request_params = extract_options_from_dict(params)
return await self._requestor.request_stream_async(
method,
url,
params=request_params,
options=request_options,
base_address=base_address,
)
def __repr__(self) -> str:
ident_parts = [type(self).__name__]
obj_str = self.get("object")
if isinstance(obj_str, str):
ident_parts.append(obj_str)
if isinstance(self.get("id"), str):
ident_parts.append("id=%s" % (self.get("id"),))
unicode_repr = "<%s at %s> JSON: %s" % (
" ".join(ident_parts),
hex(id(self)),
str(self),
)
return unicode_repr
def __str__(self) -> str:
return json.dumps(
self._to_dict_recursive(),
sort_keys=True,
indent=2,
cls=self._ReprJSONEncoder,
)
@_util.deprecated(
"Deprecated. The public interface will be removed in a future version."
)
def to_dict(self) -> Dict[str, Any]:
return dict(self)
def _to_dict_recursive(self) -> Dict[str, Any]:
def maybe_to_dict_recursive(
value: Optional[Union[StripeObject, Dict[str, Any]]],
) -> Optional[Dict[str, Any]]:
if value is None:
return None
elif isinstance(value, StripeObject):
return value._to_dict_recursive()
else:
return value
return {
key: list(map(maybe_to_dict_recursive, cast(List[Any], value)))
if isinstance(value, list)
else maybe_to_dict_recursive(value)
for key, value in dict(self).items()
}
@_util.deprecated(
"For internal stripe-python use only. The public interface will be removed in a future version."
)
def to_dict_recursive(self) -> Dict[str, Any]:
return self._to_dict_recursive()
@property
@_util.deprecated(
"For internal stripe-python use only. The public interface will be removed in a future version."
)
def stripe_id(self) -> Optional[str]:
return getattr(self, "id")
def serialize(
self, previous: Optional[Mapping[str, Any]]
) -> Dict[str, Any]:
params: Dict[str, Any] = {}
unsaved_keys = self._unsaved_values or set()
previous = previous or self._previous or {}
for k, v in self.items():
if k == "id" or k.startswith("_"):
continue
elif isinstance(v, stripe.APIResource):
continue
elif hasattr(v, "serialize"):
child = v.serialize(previous.get(k, None))
if child != {}:
params[k] = child
elif k in unsaved_keys:
params[k] = _compute_diff(v, previous.get(k, None))
elif k == "additional_owners" and v is not None:
params[k] = _serialize_list(v, previous.get(k, None))
return params
# This class overrides __setitem__ to throw exceptions on inputs that it
# doesn't like. This can cause problems when we try to copy an object
# wholesale because some data that's returned from the API may not be valid
# if it was set to be set manually. Here we override the class' copy
# arguments so that we can bypass these possible exceptions on __setitem__.
def __copy__(self) -> "StripeObject":
copied = StripeObject(
self.get("id"),
self.api_key,
stripe_version=self.stripe_version,
stripe_account=self.stripe_account,
)
copied._retrieve_params = self._retrieve_params
for k, v in self.items():
# Call parent's __setitem__ to avoid checks that we've added in the
# overridden version that can throw exceptions.
super(StripeObject, copied).__setitem__(k, v)
return copied
# This class overrides __setitem__ to throw exceptions on inputs that it
# doesn't like. This can cause problems when we try to copy an object
# wholesale because some data that's returned from the API may not be valid
# if it was set to be set manually. Here we override the class' copy
# arguments so that we can bypass these possible exceptions on __setitem__.
def __deepcopy__(self, memo: Dict[int, Any]) -> "StripeObject":
copied = self.__copy__()
memo[id(self)] = copied
for k, v in self.items():
# Call parent's __setitem__ to avoid checks that we've added in the
# overridden version that can throw exceptions.
super(StripeObject, copied).__setitem__(k, deepcopy(v, memo))
return copied
_field_remappings: ClassVar[Dict[str, str]] = {}
_inner_class_types: ClassVar[Dict[str, Type["StripeObject"]]] = {}
_inner_class_dicts: ClassVar[List[str]] = []
def _get_inner_class_type(
self, field_name: str
) -> Optional[Type["StripeObject"]]:
return self._inner_class_types.get(field_name)
def _get_inner_class_is_beneath_dict(self, field_name: str):
return field_name in self._inner_class_dicts
|