Skip to main content

Replace host and domain names in text under various encoding schemes.

Project description

Host Replace

A Python package for replacing host and domain names in text under common encoding schemes.

Features

  • Replace hostnames in text under common encodings (URL, HTML entity) while avoiding partial matches
  • Replacements are encoded in the same way
  • Supports UTF-8 string and byte inputs
  • Supports unqualified hostnames and IPv4 addresses
  • Partial support for case preservation

See sample.txt for detailed examples.

Installation

pip install host_replace

Usage

CLI

usage: host-replace [-h] [-o OUTPUT] -m MAPPING [-v] [input]

Replace hostnames and domains based on a provided mapping.

positional arguments:
  input                 input file to read from. If not provided, read from stdin

options:
  -h, --help            show this help message and exit
  -o OUTPUT, --output OUTPUT
                        output file to write the replaced content. If not provided, write to stdout
  -m MAPPING, --mapping MAPPING
                        JSON file that contains the host mapping dictionary (e.g., {"web.example.com": "www.example.net"})
  -v, --verbose         display the replacements made

API

host_map: dict of str:str mappings input_text: str or bytes

replacer = HostnameReplacer(host_map)
output_text = replacer.apply_replacements(input_text)

Limitations

  • Does not detect encoded uppercase characters. This typically occurs only when an entire hostname (not just the special characters) is URL or entity encoded.

  • Preserving the case of individual characters is not supported. For example, if we were mapping "WWW.example.com" to "example.org", would we capitalize anything?

  • Similar ambiguity applies to post-encoding casing (e.g., "%2F" vs "%2f"; "&#x2f" vs "&#X2f"), which can lead to inconsistent representation.

  • Does not process binary data beyond searching for exact byte sequences. Encodings that are not straight character-to-sequence translations (such as base64) are not supported.

  • Hostnames beginning with a hex code are ambiguous when preceded by "%". For example, should "%00example.com" match "example.com" or "00example.com"?

  • International domains have not been tested.

  • IPv6 is not supported.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

host_replace-0.1.0.tar.gz (16.4 kB view details)

Uploaded Source

Built Distribution

host_replace-0.1.0-py3-none-any.whl (17.9 kB view details)

Uploaded Python 3

File details

Details for the file host_replace-0.1.0.tar.gz.

File metadata

  • Download URL: host_replace-0.1.0.tar.gz
  • Upload date:
  • Size: 16.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.10.12

File hashes

Hashes for host_replace-0.1.0.tar.gz
Algorithm Hash digest
SHA256 a178f0fc84b4c47b33726b32145c51d9f059f7fe4cd9390448f1a4846edebacf
MD5 4652898c8838eda7cdf2ed6d42ef7689
BLAKE2b-256 2ce4aa07ed21443fa5f0b60661b4f7541e38896b58aa041a475bd568769bc2d0

See more details on using hashes here.

File details

Details for the file host_replace-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: host_replace-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 17.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.10.12

File hashes

Hashes for host_replace-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 4cde898712ee5a525a96468def6a06a769c7ebcedf3a4bb097b4df52d39efa26
MD5 066cd6f8f1c1774e84c0ebb4d5e60e1f
BLAKE2b-256 d826251bdf538a2518ccf3ee07b1ca055ccb1a470a96d7af516f314499671708

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page