"""Fetching image URLs for Eve objects."""
import enum
from typing import Optional
_EVE_IMAGE_SERVER_URL = "https://images.evetech.net"
_DEFAULT_IMAGE_SIZE = 32
[docs]
class EsiCategory(enum.Enum):
"""Enum class for ESI categories"""
ALLIANCE = enum.auto()
CHARACTER = enum.auto()
CORPORATION = enum.auto()
FACTION = enum.auto()
TYPE = enum.auto()
[docs]
class ImageVariant(enum.Enum):
"""Enum class for image variants"""
LOGO = "logo"
PORTRAIT = "portrait"
ICON = "icon"
RENDER = "render"
BPO = "bp"
BPC = "bpc"
[docs]
class EsiTenant(enum.Enum):
"""Enum class for ESI tenants"""
TRANQUILITY = "tranquility"
def _eve_entity_image_url(
category: EsiCategory,
entity_id: int,
size: int = 32,
variant: Optional[ImageVariant] = None,
tenant: Optional[EsiTenant] = None,
) -> str:
"""returns image URL for an Eve Online ID.
Supported categories: alliance, corporation, character, inventory_type
Arguments:
- category: category of the ID, see ESI category constants
- entity_id: Eve ID of the entity
- size: (optional) render size of the image.must be between 32 (default) and 1024
- variant: (optional) image variant for category.
- tenant: (optional) Eve Server, either `tranquility`(default) or `singularity`
Returns:
- URL string for the requested image on the Eve image server
Exceptions:
- Throws ValueError on invalid input
"""
# input validations
categories = {
EsiCategory.ALLIANCE: {
"endpoint": "alliances",
"variants": [ImageVariant.LOGO],
},
EsiCategory.CORPORATION: {
"endpoint": "corporations",
"variants": [ImageVariant.LOGO],
},
EsiCategory.CHARACTER: {
"endpoint": "characters",
"variants": [ImageVariant.PORTRAIT],
},
EsiCategory.FACTION: {
"endpoint": "corporations",
"variants": [ImageVariant.LOGO],
},
EsiCategory.TYPE: {
"endpoint": "types",
"variants": [
ImageVariant.ICON,
ImageVariant.RENDER,
ImageVariant.BPO,
ImageVariant.BPC,
],
},
}
if not entity_id:
raise ValueError(f"Invalid entity_id: {entity_id}")
entity_id = int(entity_id)
if not size or size < 32 or size > 1024 or (size & (size - 1) != 0):
raise ValueError(f"Invalid size: {size}")
if not isinstance(category, EsiCategory):
raise ValueError(f"Invalid category {category}")
endpoint = categories[category]["endpoint"]
if variant:
if variant not in categories[category]["variants"]:
raise ValueError(f"Invalid variant {variant} for category {category}")
my_variant = variant
else:
my_variant = categories[category]["variants"][0]
if tenant and not isinstance(tenant, EsiTenant):
raise ValueError(f"Invalid tenant {tenant}")
# compose result URL
result = (
f"{_EVE_IMAGE_SERVER_URL}/{endpoint}/{entity_id}/{my_variant.value}?size={size}"
)
if tenant:
result += f"&tenant={tenant.value}"
return result
[docs]
def alliance_logo_url(alliance_id: int, size: int = _DEFAULT_IMAGE_SIZE) -> str:
"""image URL for the given alliance ID"""
return _eve_entity_image_url(EsiCategory.ALLIANCE, alliance_id, size)
[docs]
def corporation_logo_url(corporation_id: int, size: int = _DEFAULT_IMAGE_SIZE) -> str:
"""image URL for the given corporation ID"""
return _eve_entity_image_url(EsiCategory.CORPORATION, corporation_id, size)
[docs]
def character_portrait_url(character_id: int, size: int = _DEFAULT_IMAGE_SIZE) -> str:
"""image URL for the given character ID"""
return _eve_entity_image_url(EsiCategory.CHARACTER, character_id, size)
[docs]
def faction_logo_url(faction_id: int, size: int = _DEFAULT_IMAGE_SIZE) -> str:
"""image URL for the given alliance ID"""
return _eve_entity_image_url(EsiCategory.FACTION, faction_id, size)
[docs]
def type_icon_url(type_id: int, size: int = _DEFAULT_IMAGE_SIZE) -> str:
"""icon image URL for the given type ID"""
return _eve_entity_image_url(
EsiCategory.TYPE, type_id, size, variant=ImageVariant.ICON
)
[docs]
def type_render_url(type_id: int, size: int = _DEFAULT_IMAGE_SIZE) -> str:
"""render image URL for the given type ID"""
return _eve_entity_image_url(
EsiCategory.TYPE, type_id, size, variant=ImageVariant.RENDER
)
[docs]
def type_bp_url(type_id: int, size: int = _DEFAULT_IMAGE_SIZE) -> str:
"""blueprint original image URL for the given type ID"""
return _eve_entity_image_url(
EsiCategory.TYPE, type_id, size, variant=ImageVariant.BPO
)
[docs]
def type_bpc_url(type_id: int, size: int = _DEFAULT_IMAGE_SIZE) -> str:
"""blueprint copy image URL for the given type ID"""
return _eve_entity_image_url(
EsiCategory.TYPE, type_id, size, variant=ImageVariant.BPC
)
