boxd 0.3.0.dev986__tar.gz → 0.3.0.dev1003__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (52) hide show
  1. {boxd-0.3.0.dev986/src/boxd.egg-info → boxd-0.3.0.dev1003}/PKG-INFO +1 -1
  2. {boxd-0.3.0.dev986 → boxd-0.3.0.dev1003}/pyproject.toml +1 -1
  3. {boxd-0.3.0.dev986 → boxd-0.3.0.dev1003}/src/boxd/_regions.py +65 -27
  4. {boxd-0.3.0.dev986 → boxd-0.3.0.dev1003/src/boxd.egg-info}/PKG-INFO +1 -1
  5. {boxd-0.3.0.dev986 → boxd-0.3.0.dev1003}/tests/test_regions.py +78 -0
  6. {boxd-0.3.0.dev986 → boxd-0.3.0.dev1003}/LICENSE +0 -0
  7. {boxd-0.3.0.dev986 → boxd-0.3.0.dev1003}/README.md +0 -0
  8. {boxd-0.3.0.dev986 → boxd-0.3.0.dev1003}/setup.cfg +0 -0
  9. {boxd-0.3.0.dev986 → boxd-0.3.0.dev1003}/src/boxd/__init__.py +0 -0
  10. {boxd-0.3.0.dev986 → boxd-0.3.0.dev1003}/src/boxd/_client.py +0 -0
  11. {boxd-0.3.0.dev986 → boxd-0.3.0.dev1003}/src/boxd/_credentials.py +0 -0
  12. {boxd-0.3.0.dev986 → boxd-0.3.0.dev1003}/src/boxd/_generated/__init__.py +0 -0
  13. {boxd-0.3.0.dev986 → boxd-0.3.0.dev1003}/src/boxd/_generated/api_pb2.py +0 -0
  14. {boxd-0.3.0.dev986 → boxd-0.3.0.dev1003}/src/boxd/_generated/api_pb2_grpc.py +0 -0
  15. {boxd-0.3.0.dev986 → boxd-0.3.0.dev1003}/src/boxd/_mappers.py +0 -0
  16. {boxd-0.3.0.dev986 → boxd-0.3.0.dev1003}/src/boxd/_requests.py +0 -0
  17. {boxd-0.3.0.dev986 → boxd-0.3.0.dev1003}/src/boxd/_streaming.py +0 -0
  18. {boxd-0.3.0.dev986 → boxd-0.3.0.dev1003}/src/boxd/_transport.py +0 -0
  19. {boxd-0.3.0.dev986 → boxd-0.3.0.dev1003}/src/boxd/_urls.py +0 -0
  20. {boxd-0.3.0.dev986 → boxd-0.3.0.dev1003}/src/boxd/_version_check.py +0 -0
  21. {boxd-0.3.0.dev986 → boxd-0.3.0.dev1003}/src/boxd/errors.py +0 -0
  22. {boxd-0.3.0.dev986 → boxd-0.3.0.dev1003}/src/boxd/models.py +0 -0
  23. {boxd-0.3.0.dev986 → boxd-0.3.0.dev1003}/src/boxd/py.typed +0 -0
  24. {boxd-0.3.0.dev986 → boxd-0.3.0.dev1003}/src/boxd/resources/__init__.py +0 -0
  25. {boxd-0.3.0.dev986 → boxd-0.3.0.dev1003}/src/boxd/resources/account.py +0 -0
  26. {boxd-0.3.0.dev986 → boxd-0.3.0.dev1003}/src/boxd/resources/credentials.py +0 -0
  27. {boxd-0.3.0.dev986 → boxd-0.3.0.dev1003}/src/boxd/resources/disks.py +0 -0
  28. {boxd-0.3.0.dev986 → boxd-0.3.0.dev1003}/src/boxd/resources/domains.py +0 -0
  29. {boxd-0.3.0.dev986 → boxd-0.3.0.dev1003}/src/boxd/resources/fs.py +0 -0
  30. {boxd-0.3.0.dev986 → boxd-0.3.0.dev1003}/src/boxd/resources/machines.py +0 -0
  31. {boxd-0.3.0.dev986 → boxd-0.3.0.dev1003}/src/boxd/resources/orgs.py +0 -0
  32. {boxd-0.3.0.dev986 → boxd-0.3.0.dev1003}/src/boxd/resources/regions.py +0 -0
  33. {boxd-0.3.0.dev986 → boxd-0.3.0.dev1003}/src/boxd/resources/snapshots.py +0 -0
  34. {boxd-0.3.0.dev986 → boxd-0.3.0.dev1003}/src/boxd/resources/teams.py +0 -0
  35. {boxd-0.3.0.dev986 → boxd-0.3.0.dev1003}/src/boxd/resources/vars.py +0 -0
  36. {boxd-0.3.0.dev986 → boxd-0.3.0.dev1003}/src/boxd/spec.py +0 -0
  37. {boxd-0.3.0.dev986 → boxd-0.3.0.dev1003}/src/boxd.egg-info/SOURCES.txt +0 -0
  38. {boxd-0.3.0.dev986 → boxd-0.3.0.dev1003}/src/boxd.egg-info/dependency_links.txt +0 -0
  39. {boxd-0.3.0.dev986 → boxd-0.3.0.dev1003}/src/boxd.egg-info/requires.txt +0 -0
  40. {boxd-0.3.0.dev986 → boxd-0.3.0.dev1003}/src/boxd.egg-info/top_level.txt +0 -0
  41. {boxd-0.3.0.dev986 → boxd-0.3.0.dev1003}/tests/test_credentials.py +0 -0
  42. {boxd-0.3.0.dev986 → boxd-0.3.0.dev1003}/tests/test_delete_self.py +0 -0
  43. {boxd-0.3.0.dev986 → boxd-0.3.0.dev1003}/tests/test_fs.py +0 -0
  44. {boxd-0.3.0.dev986 → boxd-0.3.0.dev1003}/tests/test_mappers.py +0 -0
  45. {boxd-0.3.0.dev986 → boxd-0.3.0.dev1003}/tests/test_namespaces.py +0 -0
  46. {boxd-0.3.0.dev986 → boxd-0.3.0.dev1003}/tests/test_python_versions.py +0 -0
  47. {boxd-0.3.0.dev986 → boxd-0.3.0.dev1003}/tests/test_requests.py +0 -0
  48. {boxd-0.3.0.dev986 → boxd-0.3.0.dev1003}/tests/test_spec.py +0 -0
  49. {boxd-0.3.0.dev986 → boxd-0.3.0.dev1003}/tests/test_streaming.py +0 -0
  50. {boxd-0.3.0.dev986 → boxd-0.3.0.dev1003}/tests/test_transport.py +0 -0
  51. {boxd-0.3.0.dev986 → boxd-0.3.0.dev1003}/tests/test_urls.py +0 -0
  52. {boxd-0.3.0.dev986 → boxd-0.3.0.dev1003}/tests/test_version_check.py +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: boxd
3
- Version: 0.3.0.dev986
3
+ Version: 0.3.0.dev1003
4
4
  Summary: Python SDK for the boxd cloud VM platform
5
5
  Author: Azin
6
6
  License-Expression: MIT
@@ -1,6 +1,6 @@
1
1
  [project]
2
2
  name = "boxd"
3
- version = "0.3.0.dev986"
3
+ version = "0.3.0.dev1003"
4
4
  description = "Python SDK for the boxd cloud VM platform"
5
5
  readme = "README.md"
6
6
  license = "MIT"
@@ -12,6 +12,11 @@ and org; it is asked again (once) when a region is missing from the answer or
12
12
  not enabled in it yet. One credential works in every region, so every
13
13
  region's transport shares the client's.
14
14
 
15
+ A call that names no org means the caller's default org. Home resolves that
16
+ itself, but a region holds only the orgs that enabled it, so the default it
17
+ would pick can be another org. A region other than home is sent the org
18
+ home's ``ListRegions`` answer names instead.
19
+
15
20
  The router has the transport's surface (``call``, ``server_stream``,
16
21
  ``bidi``, ``close``), so the resource namespaces only pass ``region=``
17
22
  through and never see an endpoint.
@@ -182,16 +187,33 @@ def _fields(request) -> Any:
182
187
  return getattr(descriptor, "fields_by_name", None)
183
188
 
184
189
 
185
- def _org_of(request) -> str | None:
186
- """The org an org-scoped call names ("" = the caller's default org), or
187
- None for a call that names none (one on a machine by name, say)."""
190
+ def _org_field(request) -> str | None:
191
+ """The request field that names the org (`org` or `org_id`), if it has one."""
188
192
  fields = _fields(request)
189
193
  if not fields:
190
194
  return None
191
- for field in ("org", "org_id"):
192
- if field in fields:
193
- return getattr(request, field)
194
- return None
195
+ return next((field for field in ("org", "org_id") if field in fields), None)
196
+
197
+
198
+ def _org_of(request) -> str | None:
199
+ """The org an org-scoped call names ("" = the caller's default org), or
200
+ None for a call that names none (one on a machine by name, say)."""
201
+ field = _org_field(request)
202
+ return None if field is None else getattr(request, field)
203
+
204
+
205
+ def _with_org(request, org: str):
206
+ """`request` with an empty org filled in with `org`, the id home's
207
+ ListRegions answer gave it. An org the caller set, a request that names
208
+ none, and an empty `org` (from a server that doesn't say) leave it as it
209
+ is."""
210
+ field = _org_field(request)
211
+ if not org or field is None or getattr(request, field):
212
+ return request
213
+ filled = type(request)()
214
+ filled.CopyFrom(request)
215
+ setattr(filled, field, org)
216
+ return filled
195
217
 
196
218
 
197
219
  def _lookup_of(method: str, request) -> tuple[str, str] | None:
@@ -337,6 +359,14 @@ class _RouterBase:
337
359
  )
338
360
  return transport
339
361
 
362
+ def _regional(self, transport, listing, request):
363
+ """`request` as `transport` is sent it. `listing` is home's answer for
364
+ the call's org: for an empty one, it names the default org, which a
365
+ region other than home is sent."""
366
+ if transport is self._home:
367
+ return request
368
+ return _with_org(request, listing.org_id)
369
+
340
370
  @staticmethod
341
371
  def _enabled(listing) -> list:
342
372
  return [r for r in listing.regions if r.org_state == "enabled"]
@@ -362,13 +392,15 @@ class SyncRouter(_RouterBase):
362
392
  err = _verdict(listing, region, org is not None)
363
393
  if err is not None:
364
394
  raise err
365
- return self._pick(listing, region)
395
+ return self._pick(listing, region), listing
366
396
 
367
397
  def _route(self, method: str, request, region: str | None):
398
+ """The transport a call goes to, and the request it is sent."""
368
399
  target = self._target(method, region)
369
400
  if target is None:
370
- return self._home
371
- return self._resolve(target, _org_of(request))
401
+ return self._home, request
402
+ transport, listing = self._resolve(target, _org_of(request))
403
+ return transport, self._regional(transport, listing, request)
372
404
 
373
405
  def _find_elsewhere(self, err, transport, lookup, org) -> None:
374
406
  if not _worth_looking(err, lookup):
@@ -388,16 +420,16 @@ class SyncRouter(_RouterBase):
388
420
  ) -> NotFoundError:
389
421
  """Look up elsewhere a not-found the SDK raises itself (an answer that
390
422
  carries nothing rather than a not-found status). Returns `err`."""
391
- transport = self._route(method, request, region)
423
+ transport, _ = self._route(method, request, region)
392
424
  self._find_elsewhere(
393
425
  err, transport, _lookup_of(method, request), _org_of(request)
394
426
  )
395
427
  return err
396
428
 
397
429
  def call(self, method: str, request, *, region: str | None = None):
398
- transport = self._route(method, request, region)
430
+ transport, sent = self._route(method, request, region)
399
431
  try:
400
- response = transport.call(method, request)
432
+ response = transport.call(method, sent)
401
433
  except NotFoundError as err:
402
434
  self._find_elsewhere(
403
435
  err, transport, _lookup_of(method, request), _org_of(request)
@@ -408,10 +440,10 @@ class SyncRouter(_RouterBase):
408
440
  return response
409
441
 
410
442
  def server_stream(self, method: str, request, *, region: str | None = None):
411
- transport = self._route(method, request, region)
443
+ transport, sent = self._route(method, request, region)
412
444
  lookup = _lookup_of(method, request)
413
445
  return _FindingStream(
414
- transport.server_stream(method, request),
446
+ transport.server_stream(method, sent),
415
447
  lambda err: self._find_elsewhere(err, transport, lookup, None),
416
448
  )
417
449
 
@@ -426,7 +458,7 @@ class SyncRouter(_RouterBase):
426
458
  ):
427
459
  """`machine` names the machine the stream is about (`Exec`), for the
428
460
  hint on a not-found."""
429
- transport = self._route(method, None, region)
461
+ transport, _ = self._route(method, None, region)
430
462
  lookup = ("machine", machine) if machine else None
431
463
  return _FindingStream(
432
464
  transport.bidi(method, requests, timeout=timeout),
@@ -449,8 +481,11 @@ class SyncRouter(_RouterBase):
449
481
  return [(listing.this_region or None, self._home.call(method, request))], []
450
482
  targets = [(r.id, self._pick(listing, r.id)) for r in enabled]
451
483
  with ThreadPoolExecutor(max_workers=len(targets)) as pool:
484
+ # Home resolves an empty org itself; the other regions are sent
485
+ # the org it resolved, so every page is of the same org.
452
486
  futures = [
453
- (rid, pool.submit(t.call, method, request)) for rid, t in targets
487
+ (rid, pool.submit(t.call, method, self._regional(t, listing, request)))
488
+ for rid, t in targets
454
489
  ]
455
490
  results, unavailable = [], []
456
491
  for rid, future in futures:
@@ -487,13 +522,15 @@ class AsyncRouter(_RouterBase):
487
522
  err = _verdict(listing, region, org is not None)
488
523
  if err is not None:
489
524
  raise err
490
- return self._pick(listing, region)
525
+ return self._pick(listing, region), listing
491
526
 
492
527
  async def _route(self, method: str, request, region: str | None):
528
+ """The transport a call goes to, and the request it is sent."""
493
529
  target = self._target(method, region)
494
530
  if target is None:
495
- return self._home
496
- return await self._resolve(target, _org_of(request))
531
+ return self._home, request
532
+ transport, listing = await self._resolve(target, _org_of(request))
533
+ return transport, self._regional(transport, listing, request)
497
534
 
498
535
  async def _find_elsewhere(self, err, transport, lookup, org) -> None:
499
536
  if not _worth_looking(err, lookup):
@@ -512,16 +549,16 @@ class AsyncRouter(_RouterBase):
512
549
  self, err: NotFoundError, method: str, request, *, region: str | None = None
513
550
  ) -> NotFoundError:
514
551
  """Async twin of :meth:`SyncRouter.find_elsewhere`."""
515
- transport = await self._route(method, request, region)
552
+ transport, _ = await self._route(method, request, region)
516
553
  await self._find_elsewhere(
517
554
  err, transport, _lookup_of(method, request), _org_of(request)
518
555
  )
519
556
  return err
520
557
 
521
558
  async def call(self, method: str, request, *, region: str | None = None):
522
- transport = await self._route(method, request, region)
559
+ transport, sent = await self._route(method, request, region)
523
560
  try:
524
- response = await transport.call(method, request)
561
+ response = await transport.call(method, sent)
525
562
  except NotFoundError as err:
526
563
  await self._find_elsewhere(
527
564
  err, transport, _lookup_of(method, request), _org_of(request)
@@ -532,10 +569,10 @@ class AsyncRouter(_RouterBase):
532
569
  return response
533
570
 
534
571
  async def server_stream(self, method: str, request, *, region: str | None = None):
535
- transport = await self._route(method, request, region)
572
+ transport, sent = await self._route(method, request, region)
536
573
  lookup = _lookup_of(method, request)
537
574
  return _AsyncFindingStream(
538
- await transport.server_stream(method, request),
575
+ await transport.server_stream(method, sent),
539
576
  lambda err: self._find_elsewhere(err, transport, lookup, None),
540
577
  )
541
578
 
@@ -548,7 +585,7 @@ class AsyncRouter(_RouterBase):
548
585
  region: str | None = None,
549
586
  machine: str | None = None,
550
587
  ):
551
- transport = await self._route(method, None, region)
588
+ transport, _ = await self._route(method, None, region)
552
589
  lookup = ("machine", machine) if machine else None
553
590
  return _AsyncFindingStream(
554
591
  await transport.bidi(method, requests, timeout=timeout),
@@ -567,7 +604,8 @@ class AsyncRouter(_RouterBase):
567
604
  return [(listing.this_region or None, response)], []
568
605
  targets = [(r.id, self._pick(listing, r.id)) for r in enabled]
569
606
  answers = await asyncio.gather(
570
- *(t.call(method, request) for _, t in targets), return_exceptions=True
607
+ *(t.call(method, self._regional(t, listing, request)) for _, t in targets),
608
+ return_exceptions=True,
571
609
  )
572
610
  results, unavailable = [], []
573
611
  for (rid, _), answer in zip(targets, answers):
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: boxd
3
- Version: 0.3.0.dev986
3
+ Version: 0.3.0.dev1003
4
4
  Summary: Python SDK for the boxd cloud VM platform
5
5
  Author: Azin
6
6
  License-Expression: MIT
@@ -427,6 +427,84 @@ def test_snapshots_and_disks_lists_carry_elsewhere_and_all():
427
427
  assert [(s.name, s.region) for s in every] == [("s1", "fra"), ("s2", "nyc")]
428
428
 
429
429
 
430
+ # --- a call that names no org ---
431
+
432
+
433
+ def created(name="a"):
434
+ return api_pb2.CreateVmResponse(vm_id=f"vm-{name}", name=name)
435
+
436
+
437
+ def test_a_region_other_than_home_is_sent_the_org_home_resolved():
438
+ router, home, made = make(
439
+ {"ListRegions": listing(), "ListVms": api_pb2.ListVmsResponse()},
440
+ {
441
+ NYC: {
442
+ "CreateVm": created(),
443
+ "GetVm": vm("a", "nyc"),
444
+ "ListVms": api_pb2.ListVmsResponse(),
445
+ }
446
+ },
447
+ )
448
+ machines = Machines(router)
449
+ machines.create("a", region="nyc")
450
+ machines.list(region="nyc")
451
+ machines.list(region="all")
452
+ machines.list(org="acme", region="nyc") # an org the caller set is kept
453
+ assert [(m, getattr(r, "org", None)) for m, r in made[NYC].calls] == [
454
+ ("CreateVm", "org-1"),
455
+ ("GetVm", None),
456
+ ("ListVms", "org-1"),
457
+ ("ListVms", "org-1"),
458
+ ("ListVms", "acme"),
459
+ ]
460
+ # Home resolves "" itself, in "all" too.
461
+ assert [r.org for m, r in home.calls if m == "ListVms"] == [""]
462
+
463
+
464
+ def test_home_is_sent_the_empty_org_as_it_is():
465
+ router, home, made = make(
466
+ {
467
+ "ListRegions": listing(),
468
+ "CreateVm": created(),
469
+ "GetVm": vm("a", "fra"),
470
+ "ListVms": api_pb2.ListVmsResponse(),
471
+ }
472
+ )
473
+ machines = Machines(router)
474
+ machines.create("a", region="fra")
475
+ machines.list(region="fra")
476
+ assert [(m, getattr(r, "org", None)) for m, r in home.calls] == [
477
+ ("ListRegions", None),
478
+ ("CreateVm", ""),
479
+ ("GetVm", None),
480
+ ("ListVms", ""),
481
+ ]
482
+ assert made == {}
483
+
484
+
485
+ def test_an_answer_that_names_no_org_leaves_it_empty():
486
+ old = listing()
487
+ old.org_id = ""
488
+ router, _, made = make(
489
+ {"ListRegions": old}, {NYC: {"ListVms": api_pb2.ListVmsResponse()}}
490
+ )
491
+ Machines(router).list(region="nyc")
492
+ assert made[NYC].calls[0][1].org == ""
493
+
494
+
495
+ async def test_async_a_region_other_than_home_is_sent_the_org_home_resolved():
496
+ router, home, made = make(
497
+ {"ListRegions": listing(), "ListVms": api_pb2.ListVmsResponse()},
498
+ {NYC: {"ListVms": api_pb2.ListVmsResponse()}},
499
+ kind=AsyncEndpoint,
500
+ )
501
+ machines = AsyncMachines(router)
502
+ await machines.list(region="nyc")
503
+ await machines.list(region="all")
504
+ assert [r.org for _, r in made[NYC].calls] == ["org-1", "org-1"]
505
+ assert [r.org for m, r in home.calls if m == "ListVms"] == [""]
506
+
507
+
430
508
  # --- not found here, found elsewhere ---
431
509
 
432
510
 
File without changes
File without changes
File without changes