Python Reference

Public API

EURING data processing library.

This package provides functionality to decode and validate EURING (European Union for Bird Ringing) data records. EURING is the standard format for bird ringing data exchange in Europe.

Main features: - Decode EURING 2000 and 2000+ format records - Validate field types and formats - Parse geographical coordinates - Look up code meanings

exception euring.EuringException

Bases: Exception

Base exception for EURING errors.

exception euring.EuringParseException

Bases: EuringException

Raised when EURING parsing or validation fails.

class euring.EuringRecord(format: str, *, strict: bool = True)

Bases: object

Build or decode EURING records.

classmethod decode(value: str, format: str | None = None) → EuringRecord

Decode a EURING record string into an EuringRecord.

property display_format: str

Return the formal EURING format name.

export(output_format: str, *, force: bool = False, warn_on_loss: bool = True) → str

Export the record to another EURING string format.

property fields: dict[str, dict[str, object]]

Return the decoded field data.

has_errors(errors: object) → bool

Return True when a structured errors payload contains entries.

serialize(output_format: str | None = None) → str

Serialize and validate a EURING record string or JSON payload.

set(key: str, value: object) → EuringRecord

Set a field value by key.

to_dict() → dict[str, object]

Return a JSON-serializable representation of the record.

update(values: dict[str, object]) → EuringRecord

Update multiple field values.

validate(record: str | None = None) → dict[str, list]

Validate all fields, then apply multi-field and record-level checks.

euring.convert_euring2000_record(value: str, target_format: str = 'euring2020') → str

Convert a fixed-width euring2000 record to euring2000plus or euring2020.

euring.convert_euring_record(value: str, source_format: str | None = None, target_format: str = 'euring2020', force: bool = False) → str

Convert EURING records between euring2000, euring2000plus, and euring2020.

euring.euring_coord_to_dms(value, degrees_pos)

Format a decimal coordinate into EURING DMS text with fixed degree width.

euring.euring_dms_to_float(value)

Convert EURING DMS coordinate text into decimal degrees.

euring.euring_float_to_dms(value, round_seconds=False)

Convert a Decimal Degree Value into Degrees Minute Seconds Notation.

Pass value as double type = {Latitude or Longitude} as string

returns a dict with quadrant, degreees, minutes, seconds created by: anothergisblog.blogspot.com modified by: Dylan Verheul

euring.euring_identification_display_format(euring_number)

Return EURING number in upper case, with anything that is not a letter or digit removed.

Parameters:

euring_number

Returns:

euring.euring_identification_export_format(euring_number)

Return EURING code formatted for display and with added internal padding (dots) up to length 10.

Parameters:

• euring_number

• length

Returns:

euring.euring_lat_to_dms(value)

Convert a latitude in decimal degrees into EURING DMS text.

euring.euring_lng_to_dms(value)

Convert a longitude in decimal degrees into EURING DMS text.

euring.euring_scheme_export_format(scheme_code)

Proper export format for a scheme code.

Parameters:

scheme_code – Scheme code (string)

Returns:

Formatted scheme code

euring.euring_species_export_format(species_code)

Proper export format for EURING species code.

Parameters:

species_code

Returns:

euring.is_alphabetic(value)

Alphabetic.

Upper case letters drawn from the 26-letter Roman alphabet, some punctuation marks (but never commas) may be included. :param value: Value to test :return: Result

euring.is_alphanumeric(value)

Alphanumeric.

Combinations of upper case letters, digits 0 to 9 and arithmetic signs. :param value: Value to test :return: Result

euring.is_integer(value)

Integer.

Whole numbers, one or more digits. Note that some fields require leading zeroes. :param value: Value to test :return: Result

euring.is_numeric(value)

Numeric.

Any numbers, with decimal points allowed. :param value: Value to test :return: Result

euring.is_numeric_signed(value)

Numeric signed.

Like Numeric, but allows a leading minus sign. The value -0 is not permitted. :param value: Value to test :return: Result

euring.is_text(value)

Text.

Any combination of letters, numbers and punctuation marks. :param value: Value to test :return: Result

euring.is_valid_type(value, type)

Return True if a value matches the specified EURING field type.

Usage examples

Build a EURING record:

from euring import EuringRecord

record = EuringRecord("euring2000plus")
record.set("ringing_scheme", "GBB")
record.set("primary_identification_method", "A0")
record.set("identification_number", "1234567890")
record.set("place_code", "AB00")
record.set("geographical_coordinates", "+0000000+0000000")
record.set("accuracy_of_coordinates", "1")
record_str = record.serialize()
record_json = record.serialize(output_format="json")
record_2020 = record.export("euring2020")

serialize() raises ValueError if required fields are missing or a value fails validation. Use EuringRecord("euring2000plus", strict=False) to allow missing optional values and keep placeholders in the output. Use export() to convert to other EURING string formats.