Aller au contenu

La version 0.1.0 est une première version, à l'essai. Voir ce qui n'est pas prouvé →

bogolang
EN

← Documentation

Types et unités

Adresses, sous-réseaux, interfaces, VLAN et unités, avec ce qui peut s'ajouter à quoi.

Toutes les pages de documentation

Cette page liste les types réseau et les unités que Bogolang connaît, comment chacun s'écrit, ce qui peut être ajouté à quoi ou comparé à quoi, et ce que la vérification refuse. Chaque nom de cette page est présent dans chaque programme, sans import.

Une valeur écrite dans le programme, comme 192.0.2.0/24 ou 20Mbps, est vérifiée lors de la vérification du programme, avant qu'il ne s'exécute. Une adresse fausse est trouvée avant qu'aucun équipement ne soit touché.

Littéraux

Un littéral s'écrit nu, sans guillemets. Il n'est reconnu qu'en dehors des chaînes et des commentaires.

Écrit Type Règle
192.0.2.10 IP Quatre nombres de 0 à 255
192.0.2.0/24 Net Une adresse, /, un préfixe de 0 à 32, sans espaces. La partie hôte vaut zéro
192.0.2.10/24 IfAddr Une adresse avec son préfixe, comme sur une interface : la partie hôte ne vaut pas zéro
00:1a:2b:3c:4d:5e MAC Six paires de chiffres hexadécimaux
20Mbps Rate bps, kbps, Mbps, Gbps
5s Duration ms, s, min, h, d
12.4km Distance m, km, et aussi ft, mi
-18.5dBm Power dBm, dBW, mW, W
2.5dB Gain dB, dBi
5.8GHz Frequency Hz, kHz, MHz, GHz
1550nm Wavelength nm
100MB Size B, kB, MB, GB (puissances de 1000), KiB, MiB, GiB (puissances de 1024)
5pct Percent pct
2.4erl Traffic erl (erlangs)
1500pps PacketRate pps

Un nombre suivi immédiatement de son unité forme un seul littéral : 5s. Avec une espace, 5 s, ce n'en est pas un. La casse d'une unité compte : Mbps est un débit, MB une taille.

Certaines valeurs entreraient en conflit avec Python si elles étaient écrites nues. Elles s'écrivent sous la forme d'un mot suivi d'un texte entre guillemets :

Écrit Type
intf"Gi1/0/24" Intf
vlan"10-20,30" VlanSet
ip"2001:db8::1", ip"2001:db8::/32" IP, Net (IPv6)
mac"001a.2b3c.4d5e" MAC (la forme à points)
time"02:00" ClockTime
Bogolang
core: IP = 192.0.2.1
lan: Net = 192.0.2.0/24
gw: IfAddr = 192.0.2.1/24
v6: Net = ip"2001:db8::/32"
uplink: Intf = intf"Gi1/0/24"
voice: VlanSet = vlan"100-110"
start: ClockTime = time"02:00"
print(core in lan, gw.net == lan, v6.version, uplink.long, 105 in voice, start)

Chaque type peut aussi être créé à partir d'un texte pendant l'exécution du programme, pour des valeurs lues dans un fichier ou sur un équipement : IP("192.0.2.1"), Net("192.0.2.0/24"), MAC("00-1A-2B-3C-4D-5E"), Rate(20, "Mbps"). Un texte faux arrête alors le programme avec le même message que celui de la vérification.

Un signe moins fait partie du littéral quand rien ne se trouve à sa gauche : -18.5dBm. Après une valeur, c'est une soustraction : a - 3dB.

Les types réseau

IP

Une adresse IPv4 ou IPv6.

Expression Résultat
ip + 5, ip - 5 IP, l'adresse située 5 plus loin ou 5 avant
ip < other, >, <=, >= bool, entre deux adresses de la même version
ip in net bool
.version 4 ou 6
.is_private bool
.to_python() l'objet adresse du module ipaddress de Python

Net

Un sous-réseau. La partie hôte doit valoir zéro : 192.0.2.5/24 écrit comme un Net est refusé.

Expression Résultat
.address, .mask, .wildcard, .broadcast IP
.prefix, .size, .version int (.size compte toutes les adresses)
.hosts chaque adresse utilisable, l'une après l'autre
.split(26) list[Net], les sous-réseaux de ce préfixe (65536 au plus)
.overlaps(other) bool
ip in net, small in net bool, pour une adresse ou un sous-réseau plus petit
.to_python() l'objet réseau du module ipaddress de Python
Bogolang
n = 192.0.2.0/24
print(n.size, n.mask, n.wildcard, n.broadcast, len(list(n.hosts)))
print(n.split(26)[1], (10.0.0.0/8).overlaps(10.1.0.0/16))

Ceci affiche :

256 255.255.255.0 0.0.0.255 192.0.2.255 254
192.0.2.64/26 True

Quatre fonctions planifient des adresses avec des valeurs Net. planning-routes-acl.md les décrit.

Fonction Résultat
summarize(nets) la liste la plus courte de sous-réseaux qui couvre les mêmes adresses
next_free(block, prefix, used) le premier sous-réseau de ce préfixe dans le bloc qui ne chevauche aucun sous-réseau utilisé
free_nets(block, used) l'espace libre du bloc, sous la forme du plus petit nombre de sous-réseaux
net_of(address, mask) le réseau qui contient l'adresse, à partir d'un masque ou d'un masque générique (IPv4)

IfAddr

Une adresse avec son préfixe, telle que configurée sur une interface. .ip donne l'IP, .net le Net, .prefix la longueur.

MAC

S'écrit 00:1a:2b:3c:4d:5e, 00-1A-2B-3C-4D-5E ou 001a.2b3c.4d5e ; les trois sont la même adresse. Elle s'affiche avec des deux-points. .cisco donne la forme à points, .oui les trois premières paires. vendor(mac) donne le fabricant d'après la liste publique de l'IEEE.

Intf

Un nom d'interface. Gi1/0/24, Gig1/0/24 et GigabitEthernet1/0/24 sont la même interface, comme IOS les lit. .short, .long, .kind et .numbers donnent ses parties. Les interfaces se trient par type, puis par numéro, donc Gi1/0/2 vient avant Gi1/0/10.

Bogolang
p = intf"Gi1/0/24"
print(p, p.long, p.numbers, p == intf"GigabitEthernet1/0/24")
Gi1/0/24 GigabitEthernet1/0/24 (1, 0, 24) True

VlanSet

Un ensemble de numéros de VLAN, de 1 à 4094, écrit comme une liste avec des plages.

Expression Résultat
15 in v bool
a + b l'union
a - b la différence
len(v) le nombre de VLAN
for n in v chaque numéro, dans l'ordre
Bogolang
v = vlan"10-20,30"
print(v + vlan"21", v - vlan"15-20", len(v), list(vlan"5-7"))
10-21,30 10-14,30 12 [5, 6, 7]

Les unités

Chaque sorte de grandeur est son propre type. Une valeur est conservée dans l'unité de base de sa sorte et n'est jamais arrondie. Elle s'affiche dans la plus grande unité où le nombre vaut au moins 1, avec trois décimales au plus : 1.5Gbps, 250ms, et 90s s'affiche 1.5min. Une puissance s'affiche toujours en dBm et un gain en dB. .to("kbps") donne le nombre seul dans l'unité de votre choix.

Type Unité de base Unités
Rate bps bps, kbps, Mbps, Gbps
Duration s ms, s, min, h, d
Distance m m, km, ft, mi (affichée en m ou en km)
Power dBm dBm, dBW, mW, W (affichée en dBm ; mW et W doivent être supérieurs à zéro)
Gain dB dB, dBi (le même nombre)
Frequency Hz Hz, kHz, MHz, GHz
Wavelength nm nm
Size B B, kB, MB, GB, KiB, MiB, GiB (affichée de B à GB)
Percent pct pct ; les valeurs inférieures à 0 et supérieures à 100 sont permises ; .fraction donne 0.05 pour 5pct
Traffic erl erl
PacketRate pps pps
ClockTime time"HH:MM", de 00:00 à 23:59

Ce qui peut être ajouté à quoi

Opération Résultat
Rate + Rate, Rate - Rate Rate. Les préfixes sont pris en compte : 1Gbps + 500Mbps vaut 1.5Gbps
La même chose pour Duration, Distance, Size, Frequency, Wavelength, Percent, Traffic, PacketRate La même sorte
Rate * Duration, Duration * Rate Size
Size / Duration Rate. Les bits et les octets diffèrent d'un facteur 8 : 100MB / 10s vaut 80Mbps
Size / Rate Duration
Une grandeur / une grandeur de la même sorte float
Une grandeur * ou / un nombre seul La même sorte
Power - Power Gain
Power + Gain, Power - Gain, Gain + Power Power
Gain + Gain, Gain - Gain Gain
Power + Power Refusé. Utilisez combine(a, b), qui les additionne en milliwatts
freq.wavelength, wl.frequency Une Wavelength à partir d'une Frequency, et inversement. Jamais d'elle-même
<, >, <=, >= Uniquement entre deux valeurs de la même sorte
Tout le reste Refusé avant l'exécution du programme
Bogolang
print(1Gbps + 500Mbps, 100MB / 10s, 20Mbps * 1min, 1GB / 100Mbps)
print(-18.5dBm - -21dBm, -18.5dBm + 3dB, combine(-10dBm, -10dBm))
print(12.4km / 2, 12.4km / 3.1km, 90s, 20Mbps.to("kbps"), 2W)

Ceci affiche :

1.5Gbps 80Mbps 150MB 1.333min
2.5dB -15.5dBm -6.99dBm
6.2km 4.0 1.5min 20000.0 33.01dBm

Les valeurs ClockTime se comparent entre elles (time"02:00" < time"04:00") et servent dans only between (language.md).

Ce que la vérification refuse

Un littéral faux est trouvé à la lecture du fichier, avec le littéral souligné. Chaque message ci-dessous est celui que la vérification a affiché.

Écrit Message
192.0.2.256 '192.0.2.256' is not a valid IP address: Octet 256 (> 255) not permitted in '192.0.2.256'
ip"192.0.2.5/24" '192.0.2.5/24' is not a subnet: the host part is not zero. It belongs to 192.0.2.0/24. Write 192.0.2.0/24, or use IfAddr for an interface address.
20Mbs "Mbs" is not a known unit, avec l'indice Did you mean 20Mbps?
vlan"0-10" VLAN 0 in '0-10' is out of range. VLAN numbers are 1 to 4094.
vlan"20-10" the range 20-10 in '20-10' is reversed. Write 10-20.
mac"001a.2b3c.4d5" '001a.2b3c.4d5' is not a MAC address. It has 11 hex digits, a MAC has 12. Write it as 00:1a:2b:3c:4d:5e, 00-1A-2B-3C-4D-5E or 001a.2b3c.4d5e.
intf"1/0/1" '1/0/1' is not an interface name. Write a kind then numbers, such as Gi1/0/24 or Vlan10.
time"25:00" time must be HH:MM from 00:00 to 23:59, got '25:00'

Une somme fausse est trouvée par la vérification des types :

Écrit Message
20Mbps + -18.5dBm cannot use + between Rate and Power
-10dBm + -12dBm cannot use + between Power and Power, avec l'indice Use combine(a, b) to add two power levels.
20Mbps < 5s cannot use < between Rate and Duration
1550nm + 5GHz cannot use + between Wavelength and Frequency
192.0.2.1 + 1.5 cannot use + between IP and float
20Mbps * 20Mbps No overload variant of "__mul__" of "Rate" matches argument type "Rate", avec les formes qui sont permises

La vérification s'exécute avant le programme, donc ces lignes ne s'exécutent jamais. Là où aucune vérification ne s'exécute, comme dans bogo shell ou sur une valeur venant d'un objet Untyped, les types refusent eux-mêmes la mauvaise sorte quand la ligne s'exécute, avec une TypeError aux mêmes mots, comme cannot use + between Rate and Size.

Limites

  • == entre deux sortes différentes n'est pas refusé avant l'exécution. Il vaut False : 20Mbps == 5s vaut False.
  • Un littéral à l'intérieur des {} d'une f-string n'est pas reconnu. Mettez d'abord la valeur dans une variable.
  • Pour une unité inconnue, l'unité connue la plus proche est proposée : d'abord les mêmes lettres dans une autre casse (5Kbps reçoit Did you mean 5kbps?), puis l'orthographe la plus proche.
  • Un fichier qui définit sa propre classe nommée Net, Power ou un autre type intégré ne peut pas aussi écrire le littéral correspondant.