IPCalc 技术文档

1. 安装指南

1.1 通过 pip 安装

IPCalc 可以通过 pip 工具进行安装。确保你已经安装了 Python 和 pip，然后在命令行中运行以下命令：

pip install ipcalc

1.2 从源码安装

如果你希望从源码安装 IPCalc，可以按照以下步骤操作：

1. 克隆项目仓库到本地：

   git clone https://github.com/tehmaze/ipcalc.git
   

2. 进入项目目录：

   cd ipcalc
   

3. 使用 pip 安装：

   pip install .
   

2. 项目的使用说明

IPCalc 是一个用于进行 IP 子网计算的 Python 模块，支持 IPv4 和 IPv6 的 CIDR 表示法。以下是一些基本的使用示例：

2.1 基本使用

import ipcalc

# 遍历一个 IPv4 网络中的所有 IP 地址
for ip in ipcalc.Network('172.16.42.0/30'):
    print(str(ip))

# 输出:
# 172.16.42.1
# 172.16.42.2

# 创建一个 IPv6 网络对象
subnet = ipcalc.Network('2001:beef:babe::/48')

# 获取网络地址
print(str(subnet.network()))
# 输出: 2001:beef:babe:0000:0000:0000:0000:0000

# 获取子网掩码
print(str(subnet.netmask()))
# 输出: ffff:ffff:ffff:0000:0000:0000:0000:0000

# 检查一个 IP 地址是否在某个网络中
print('192.168.42.23' in ipcalc.Network('192.168.42.0/24'))
# 输出: True

# 将 IPv6 地址转换为整数
print(int(ipcalc.IP('fe80::213:ceff:fee8:c937')))
# 输出: 338288524927261089654168587652869703991

3. 项目 API 使用文档

3.1 ipcalc.Network

Network 类用于表示一个 IP 网络。你可以通过传入一个 CIDR 格式的字符串来创建一个 Network 对象。

network = ipcalc.Network('192.168.1.0/24')

方法

• network(): 返回网络地址。
• netmask(): 返回子网掩码。
• broadcast(): 返回广播地址。
• hosts(): 返回一个生成器，遍历网络中的所有主机地址。

3.2 ipcalc.IP

IP 类用于表示一个单独的 IP 地址。你可以通过传入一个 IP 地址字符串来创建一个 IP 对象。

ip = ipcalc.IP('192.168.1.1')

方法

• int(): 将 IP 地址转换为整数。
• str(): 返回 IP 地址的字符串表示。

3.3 其他功能

• in 操作符：用于检查一个 IP 地址是否在某个网络中。
• for 循环：用于遍历网络中的所有 IP 地址。

4. 项目安装方式

4.1 通过 pip 安装

这是最简单的安装方式，适用于大多数用户：

pip install ipcalc

4.2 从源码安装

如果你需要自定义安装或希望参与项目开发，可以从源码安装：

1. 克隆项目仓库：

   git clone https://github.com/tehmaze/ipcalc.git
   

2. 进入项目目录：

   cd ipcalc
   

3. 使用 pip 安装：

   pip install .
   

通过以上步骤，你可以成功安装并使用 IPCalc 模块进行 IP 子网计算。