ipregistry-fastapi 1.0.0__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.
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright [yyyy] [name of copyright owner]
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
@@ -0,0 +1,359 @@
1
+ Metadata-Version: 2.4
2
+ Name: ipregistry-fastapi
3
+ Version: 1.0.0
4
+ Summary: Official Ipregistry integration for FastAPI: dependency-driven IP geolocation and threat detection for every request
5
+ Keywords: fastapi,starlette,ipinfo,ipregistry,ip-address,ip-data,ip-geolocation,geoblocking,threat-detection,user-agent-parsing
6
+ Author: Ipregistry Team, Laurent Pellegrino
7
+ Author-email: Ipregistry Team <support@ipregistry.co>, Laurent Pellegrino <laurent.pellegrino@ipregistry.co>
8
+ License-Expression: Apache-2.0
9
+ License-File: LICENSE.txt
10
+ Classifier: Framework :: FastAPI
11
+ Classifier: Intended Audience :: Developers
12
+ Classifier: Operating System :: OS Independent
13
+ Classifier: Programming Language :: Python :: 3
14
+ Classifier: Programming Language :: Python :: 3.10
15
+ Classifier: Programming Language :: Python :: 3.11
16
+ Classifier: Programming Language :: Python :: 3.12
17
+ Classifier: Programming Language :: Python :: 3.13
18
+ Classifier: Programming Language :: Python :: 3.14
19
+ Classifier: Topic :: Internet
20
+ Classifier: Topic :: Software Development :: Libraries :: Python Modules
21
+ Classifier: Typing :: Typed
22
+ Requires-Dist: fastapi>=0.115.0
23
+ Requires-Dist: ipregistry[async]>=5.0.0,<6.0.0
24
+ Requires-Dist: pydantic>=2.13.4,<3.0.0
25
+ Requires-Dist: pydantic-settings>=2.6.0,<3.0.0
26
+ Requires-Python: >=3.10
27
+ Project-URL: Homepage, https://ipregistry.co
28
+ Project-URL: Repository, https://github.com/ipregistry/ipregistry-fastapi
29
+ Description-Content-Type: text/markdown
30
+
31
+ # Ipregistry FastAPI
32
+
33
+ [![License](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](LICENSE.txt)
34
+ [![Tests](https://github.com/ipregistry/ipregistry-fastapi/actions/workflows/tests.yaml/badge.svg)](https://github.com/ipregistry/ipregistry-fastapi/actions/workflows/tests.yaml)
35
+ [![PyPI](https://img.shields.io/pypi/v/ipregistry-fastapi.svg)](https://pypi.org/project/ipregistry-fastapi/)
36
+
37
+ Official [Ipregistry](https://ipregistry.co) integration for [FastAPI](https://fastapi.tiangolo.com):
38
+ dependency-driven IP geolocation and threat detection for every request, built on the asynchronous
39
+ [Ipregistry Python client](https://github.com/ipregistry/ipregistry-python).
40
+
41
+ ```python
42
+ from fastapi import FastAPI
43
+ from ipregistry_fastapi import IpInfoDep, ipregistry_lifespan
44
+
45
+ app = FastAPI(lifespan=ipregistry_lifespan)
46
+
47
+ @app.get("/")
48
+ async def index(info: IpInfoDep):
49
+ return {"country": info.location.country.name if info else None}
50
+ ```
51
+
52
+ ## Features
53
+
54
+ - **Async-first**: non-blocking lookups through the official asynchronous Ipregistry client, with
55
+ connection reuse managed by the application lifespan.
56
+ - **Idiomatic dependencies**: `IpInfoDep`, `IpregistryDep` and `ClientIpDep` annotated types plug
57
+ straight into path operations — HTTP and WebSocket alike; one cached lookup per request, shared
58
+ by every consumer. All dependencies are coroutines: no threadpool dispatch on the request path.
59
+ - **Guards**: block countries (HTTP 451) and threats (HTTP 403) per route, per router, or app-wide.
60
+ - **Middleware**: optional pure-ASGI middleware for global enrichment and blocking, with static
61
+ asset and bot skipping to save credits.
62
+ - **Safe by default**: fails open, never sends private or reserved addresses to the API, validates
63
+ proxy headers, and never logs full client IPs.
64
+ - **Configuration via environment**: `IPREGISTRY_*` variables parsed with pydantic-settings.
65
+ - **Typed responses**: lookups return the client's Pydantic v2 models, ready to embed in your own
66
+ response models.
67
+ - **First-class testing**: `IpregistryFake` swaps in canned responses with call assertions —
68
+ no network, no API key.
69
+
70
+ ## Getting started
71
+
72
+ ### Requirements
73
+
74
+ - Python 3.10+
75
+ - FastAPI 0.115+
76
+ - An [Ipregistry API key](https://dashboard.ipregistry.co) — the free tier includes 100,000 lookups
77
+
78
+ ### Installation
79
+
80
+ ```console
81
+ pip install ipregistry-fastapi
82
+ ```
83
+
84
+ or with [uv](https://docs.astral.sh/uv/):
85
+
86
+ ```console
87
+ uv add ipregistry-fastapi
88
+ ```
89
+
90
+ ### Quick start
91
+
92
+ Set your API key:
93
+
94
+ ```console
95
+ export IPREGISTRY_API_KEY=YOUR_API_KEY
96
+ ```
97
+
98
+ Wire the lifespan and use the dependency:
99
+
100
+ ```python
101
+ from fastapi import FastAPI
102
+ from ipregistry_fastapi import IpInfoDep, ipregistry_lifespan
103
+
104
+ app = FastAPI(lifespan=ipregistry_lifespan)
105
+
106
+ @app.get("/whoami")
107
+ async def whoami(info: IpInfoDep):
108
+ if info is None:
109
+ return {"detail": "No IP intelligence available"}
110
+ return {
111
+ "ip": info.ip,
112
+ "country": info.location.country.name,
113
+ "city": info.location.city,
114
+ "threat": info.security.is_threat,
115
+ }
116
+ ```
117
+
118
+ `IpInfoDep` resolves to an [`IpInfo`](https://ipregistry.co/docs/) model — or `None` when the
119
+ client IP is private (e.g. on localhost) or the lookup failed. One lookup runs per request no
120
+ matter how many dependencies, guards or middleware consume it, and responses are cached in memory
121
+ across requests.
122
+
123
+ To configure programmatically instead of via the environment:
124
+
125
+ ```python
126
+ from ipregistry_fastapi import IpregistrySettings, add_ipregistry, ipregistry_lifespan
127
+
128
+ app = FastAPI(lifespan=ipregistry_lifespan)
129
+ add_ipregistry(app, IpregistrySettings(api_key="...", base_url="eu", fields="location,security"))
130
+ ```
131
+
132
+ ## Blocking countries
133
+
134
+ `block_countries` returns a dependency enforcing an ISO 3166-1 alpha-2 country list. Blocked
135
+ visitors receive `451 Unavailable For Legal Reasons` by default. Invalid codes fail at declaration
136
+ time, not at request time.
137
+
138
+ ```python
139
+ from fastapi import APIRouter, Depends
140
+ from ipregistry_fastapi import block_countries
141
+
142
+ router = APIRouter(dependencies=[Depends(block_countries("KP", "SY"))])
143
+
144
+ # Allowlist mode: only serve the EU single market
145
+ checkout = APIRouter(dependencies=[Depends(block_countries(EU_COUNTRIES, mode="allow"))])
146
+ ```
147
+
148
+ Requests whose country cannot be determined are allowed unless you pass `unknown="block"`.
149
+
150
+ ## Blocking threats
151
+
152
+ `block_threats` blocks IPs flagged as threats, attackers or abusers, and responds with `403`.
153
+ Anonymization signals are opt-in — a VPN user is not necessarily hostile:
154
+
155
+ ```python
156
+ from fastapi import Depends, FastAPI
157
+ from ipregistry_fastapi import block_threats
158
+
159
+ app = FastAPI(dependencies=[Depends(block_threats())])
160
+
161
+ # Stricter variant for sensitive routes:
162
+ admin = APIRouter(dependencies=[Depends(block_threats(proxy=True, tor=True, vpn=True, relay=True))])
163
+ ```
164
+
165
+ Requests without security data are allowed (fail open), so an Ipregistry outage never locks users
166
+ out of your API.
167
+
168
+ ## Middleware
169
+
170
+ Prefer dependencies for per-route rules. Reach for the middleware to enforce app-wide policies or
171
+ eagerly enrich every request — including ones that never match a route:
172
+
173
+ ```python
174
+ from ipregistry_fastapi import IpregistryMiddleware, block_countries, block_threats
175
+
176
+ app.add_middleware(
177
+ IpregistryMiddleware,
178
+ actions=[block_countries("KP"), block_threats(tor=True)],
179
+ skip_bots=True, # skip lookups for crawler user agents
180
+ skip_static_assets=True, # default: skip .css/.js/images/fonts
181
+ skip=lambda request: request.url.path.startswith("/health"),
182
+ )
183
+ ```
184
+
185
+ The middleware stores the lookup on `request.state.ipregistry`, so `IpInfoDep` and route guards
186
+ reuse it for free.
187
+
188
+ ### Fail open or closed
189
+
190
+ By default a failed lookup lets the request proceed with `info = None` (fail open). To refuse
191
+ requests instead when IP intelligence is unavailable:
192
+
193
+ - set `IPREGISTRY_FAIL_OPEN=false` — `IpInfoDep` and blocking dependencies respond with `503`;
194
+ - or pass `fail_closed=True` (or a custom status code) to `IpregistryMiddleware`.
195
+
196
+ ## GDPR & EU detection
197
+
198
+ ```python
199
+ from ipregistry_fastapi import IpInfoDep, is_eu
200
+
201
+ @app.get("/consent")
202
+ async def consent(info: IpInfoDep):
203
+ return {"show_banner": is_eu(info, assume_eu=True)}
204
+ ```
205
+
206
+ `is_eu` reads `location.in_eu`; `assume_eu=True` errs on the side of showing a consent banner when
207
+ the location is unknown. For EU data residency, set `IPREGISTRY_BASE_URL=eu` to route all API
208
+ requests to `https://eu.api.ipregistry.co`.
209
+
210
+ Related helpers: `is_threat(info, vpn=True, ...)` and `is_bot(request)` (heuristic, no API call).
211
+
212
+ ## Configuration
213
+
214
+ All settings load from the environment via
215
+ [pydantic-settings](https://docs.pydantic.dev/latest/concepts/pydantic_settings/), or can be passed
216
+ programmatically with `IpregistrySettings`:
217
+
218
+ | Environment variable | Default | Description |
219
+ | ------------------------------------- | -------- | -------------------------------------------------------------------- |
220
+ | `IPREGISTRY_API_KEY` | — | **Required.** Your Ipregistry API key. |
221
+ | `IPREGISTRY_BASE_URL` | default | API endpoint; `eu` selects the EU-only endpoint; full URLs verbatim. |
222
+ | `IPREGISTRY_FIELDS` | all | Default field selection, e.g. `location,security`. |
223
+ | `IPREGISTRY_HOSTNAME` | `false` | Resolve the hostname of looked up IPs. |
224
+ | `IPREGISTRY_TIMEOUT` | `5.0` | Request timeout in seconds. |
225
+ | `IPREGISTRY_RETRIES` | `1` | Retry attempts after a failed request. |
226
+ | `IPREGISTRY_RETRY_INTERVAL` | `0.5` | Base delay between retries (exponential backoff). |
227
+ | `IPREGISTRY_RETRY_ON_SERVER_ERROR` | `true` | Retry on 5xx responses. |
228
+ | `IPREGISTRY_RETRY_ON_TOO_MANY_REQUESTS`| `false` | Retry on 429 responses (honors `Retry-After`). |
229
+ | `IPREGISTRY_CACHE_ENABLED` | `true` | Cache lookups in memory. |
230
+ | `IPREGISTRY_CACHE_MAX_SIZE` | `2048` | Maximum cached lookups. |
231
+ | `IPREGISTRY_CACHE_TTL` | `600` | Cache time-to-live in seconds. |
232
+ | `IPREGISTRY_DEVELOPMENT_IP` | — | Fallback IP when the client IP is private (e.g. localhost). |
233
+ | `IPREGISTRY_FAIL_OPEN` | `true` | Proceed without data when a lookup fails. |
234
+ | `IPREGISTRY_IP_SOURCE` | `client` | How to resolve the client IP (see below). |
235
+
236
+ Selecting only the fields you need (e.g. `IPREGISTRY_FIELDS=location,security`) reduces latency
237
+ and response size.
238
+
239
+ ## IP extraction behind proxies
240
+
241
+ By default (`client`) the library uses the ASGI client address — the right choice when uvicorn
242
+ runs with `--proxy-headers --forwarded-allow-ips` or behind
243
+ `ProxyHeadersMiddleware`, which already resolve the real client IP.
244
+
245
+ If your server does not rewrite the client address, pick the header set by a proxy you trust:
246
+
247
+ | `IPREGISTRY_IP_SOURCE` | Headers consulted (in order) |
248
+ | ---------------------- | -------------------------------- |
249
+ | `client` (default) | none — ASGI client address |
250
+ | `auto` | `X-Real-IP`, `X-Forwarded-For` |
251
+ | `cloudflare` | `CF-Connecting-IP` |
252
+ | `nginx` | `X-Real-IP`, `X-Forwarded-For` |
253
+ | `forwarded-for` | `X-Forwarded-For` (first entry) |
254
+ | `header:<name>` | the named header |
255
+
256
+ A callable `ip_extractor` can also be passed to `Ipregistry`/`add_ipregistry` for full control.
257
+ Values are sanitized (ports, IPv6 brackets and zone IDs stripped) and validated; only configure
258
+ headers your proxy overwrites — client-supplied headers are trivially spoofable. Private,
259
+ loopback and carrier-grade NAT addresses are never sent to the API; set
260
+ `IPREGISTRY_DEVELOPMENT_IP` to test with a fixed address on localhost.
261
+
262
+ ## Caching and credits
263
+
264
+ Lookups are cached in memory (2048 entries, 10 minutes by default), so repeated requests from the
265
+ same address consume a single credit. On top of that:
266
+
267
+ - one lookup per request, however many consumers;
268
+ - static asset and bot skipping in the middleware;
269
+ - private/reserved IPs short-circuit before reaching the API.
270
+
271
+ Multi-worker deployments (`uvicorn --workers`, gunicorn) hold one cache per process.
272
+
273
+ ## Testing your app
274
+
275
+ `IpregistryFake` is a drop-in service with canned responses and no network access:
276
+
277
+ ```python
278
+ from fastapi.testclient import TestClient
279
+ from ipregistry_fastapi import add_ipregistry
280
+ from ipregistry_fastapi.testing import IpregistryFake
281
+
282
+ fake = IpregistryFake({
283
+ "66.165.2.7": {"location": {"country": {"code": "US"}}},
284
+ "*": {"security": {"is_threat": False}}, # any other address
285
+ })
286
+ add_ipregistry(app, service=fake)
287
+
288
+ client = TestClient(app)
289
+ response = client.get("/whoami", headers={"x-real-ip": "66.165.2.7"})
290
+
291
+ fake.assert_looked_up("66.165.2.7")
292
+ ```
293
+
294
+ Stubs are API-shaped dicts, `IpInfo` instances, or exceptions to raise. Unlike the real service,
295
+ the fake accepts private addresses so requests made through `TestClient` resolve out of the box.
296
+ Assertions: `assert_looked_up`, `assert_not_looked_up`, `assert_looked_up_times`,
297
+ `assert_nothing_looked_up`, `assert_origin_looked_up`, `assert_user_agents_parsed`.
298
+
299
+ FastAPI's standard [`dependency_overrides`](https://fastapi.tiangolo.com/advanced/testing-dependencies/)
300
+ mechanism works too, and propagates to `IpInfoDep` and the blocking guards:
301
+
302
+ ```python
303
+ from ipregistry_fastapi import get_ipregistry
304
+
305
+ app.dependency_overrides[get_ipregistry] = lambda: fake
306
+ ```
307
+
308
+ ## Errors
309
+
310
+ Request-aware helpers (`IpInfoDep`, guards, middleware) never raise on lookup failure — they fail
311
+ open and record the exception on `request.state.ipregistry_error`. Explicit lookups raise the
312
+ client's exceptions:
313
+
314
+ ```python
315
+ from ipregistry_fastapi import ApiError, ClientError, ErrorCode, IpregistryDep
316
+
317
+ @app.get("/lookup/{ip}")
318
+ async def lookup(ip: str, ipregistry: IpregistryDep):
319
+ try:
320
+ return await ipregistry.lookup(ip)
321
+ except ApiError as error:
322
+ if error.error_code == ErrorCode.INVALID_IP_ADDRESS:
323
+ raise HTTPException(status_code=400, detail=error.message)
324
+ raise HTTPException(status_code=502, detail="Lookup failed")
325
+ except ClientError:
326
+ raise HTTPException(status_code=504, detail="Ipregistry unreachable")
327
+ ```
328
+
329
+ ## Beyond IP lookups
330
+
331
+ The full asynchronous client remains available for batch lookups, ASN data, user-agent parsing and
332
+ credits introspection:
333
+
334
+ ```python
335
+ @app.post("/enrich")
336
+ async def enrich(ips: list[str], ipregistry: IpregistryDep):
337
+ results = await ipregistry.lookup_batch(ips) # order-preserving
338
+ origin = await ipregistry.lookup_origin() # the server's own IP
339
+ asn = await ipregistry.client.lookup_asn(400923) # raw client escape hatch
340
+ ```
341
+
342
+ ## Migrating from ipregistry-python
343
+
344
+ Existing `ipregistry` client code keeps working — this package layers FastAPI wiring on top:
345
+
346
+ - replace manual client creation with `ipregistry_lifespan` / `add_ipregistry`;
347
+ - replace per-endpoint lookups of the request IP with `IpInfoDep`;
348
+ - move country/threat checks into `block_countries` / `block_threats` dependencies;
349
+ - configuration moves to `IPREGISTRY_*` environment variables.
350
+
351
+ ## Other resources
352
+
353
+ - [Ipregistry documentation](https://ipregistry.co/docs)
354
+ - [Ipregistry Python client](https://github.com/ipregistry/ipregistry-python)
355
+ - [API status](https://status.ipregistry.co)
356
+
357
+ ## License
358
+
359
+ [Apache-2.0](LICENSE.txt) © [Ipregistry](https://ipregistry.co)