flet-map 0.2.0.dev46__py3-none-any.whl → 0.2.0.dev63__py3-none-any.whl

flet_map/marker_layer.py

@@ -1,10 +1,10 @@
 from dataclasses import field
-from typing import List, Optional
+from typing import Optional
 
 import flet as ft
 
-from .map_layer import MapLayer
-from .types import MapLatitudeLongitude
+from flet_map.map_layer import MapLayer
+from flet_map.types import MapLatitudeLongitude
 
 __all__ = ["Marker", "MarkerLayer"]
 
@@ -12,16 +12,18 @@ __all__ = ["Marker", "MarkerLayer"]
 @ft.control("Marker")
 class Marker(ft.Control):
     """
-    A marker displayed on the Map at the specified location through the [`MarkerLayer`][(p).].
+    A marker displayed on the Map at the specified location
+    through the [`MarkerLayer`][(p).].
 
     Raises:
-        AssertionError: If the [`content`][(c).] is not visible, or if [`height`][(c).] or [`width`][(c).] are negative.
+        AssertionError: If the [`content`][(c).] is not visible, or
+            if [`height`][(c).] or [`width`][(c).] are negative.
     """
 
     content: ft.Control
     """
     The content to be displayed at [`coordinates`][..].
-    
+
     Note:
         Must be provided and visible.
     """
@@ -29,24 +31,29 @@ class Marker(ft.Control):
     coordinates: MapLatitudeLongitude
     """
     The coordinates of the marker.
-    
-    This will be the center of the marker, if `alignment=ft.Alignment.center()`.
+
+    This will be the center of the marker,
+    if [`alignment`][..] is [`Alignment.CENTER`][flet.Alignment.CENTER].
     """
 
     rotate: Optional[bool] = None
     """
-    Whether to counter rotate this marker to the map's rotation, to keep a fixed orientation.
-    So, when `True`, this marker will always appear upright and vertical from the user's perspective.
-    
-    Note: this is not used to apply a custom rotation in degrees to the marker.
-    
-    Defaults to the value of the parent [`MarkerLayer.rotate`][(p).].
+    Whether to counter rotate this marker to the map's rotation,
+    to keep a fixed orientation.
+    So, when `True`, this marker will always appear upright and
+    vertical from the user's perspective.
+
+    If `None`, defaults to the value of the parent [`MarkerLayer.rotate`][(p).].
+
+    Note:
+        This is not used to apply a custom rotation in degrees to this marker.
+
     """
 
     height: ft.Number = 30.0
     """
     The height of the [`content`][..] Control.
-    
+
     Note:
         Must be non-negative.
     """
@@ -54,7 +61,7 @@ class Marker(ft.Control):
     width: ft.Number = 30.0
     """
     The width of the [`content`][..] Control.
-    
+
     Note:
         Must be non-negative.
     """
@@ -62,15 +69,19 @@ class Marker(ft.Control):
     alignment: Optional[ft.Alignment] = None
     """
     Alignment of the marker relative to the normal center at [`coordinates`][..].
-    
-    Defaults to the value of the parent [`MarkerLayer.alignment`][(m).].
+
+    Defaults to the value of the parent [`MarkerLayer.alignment`][(p).].
     """
 
     def before_update(self):
         super().before_update()
         assert self.content.visible, "content must be visible"
-        assert self.height >= 0, "height must be greater than or equal to 0"
-        assert self.width >= 0, "width must be greater than or equal to 0"
+        assert self.height >= 0, (
+            f"height must be greater than or equal to 0, got {self.height}"
+        )
+        assert self.width >= 0, (
+            f"width must be greater than or equal to 0, got {self.width}"
+        )
 
 
 @ft.control("MarkerLayer")
@@ -79,19 +90,21 @@ class MarkerLayer(MapLayer):
     A layer to display Markers.
     """
 
-    markers: List[Marker]
+    markers: list[Marker]
     """
-    List of [`Marker`][(m).]s to display.
+    A list of [`Marker`][(m).]s to display.
     """
 
     alignment: Optional[ft.Alignment] = field(
-        default_factory=lambda: ft.Alignment.center()
+        default_factory=lambda: ft.Alignment.CENTER
     )
     """
-    Alignment of each marker relative to its normal center at `Marker.coordinates`.
+    The alignment of each marker relative to its normal center at
+    [`Marker.coordinates`][(m).].
     """
 
     rotate: bool = False
     """
-    Whether to counter-rotate `markers` to the map's rotation, to keep a fixed orientation.
+    Whether to counter-rotate `markers` to the map's rotation,
+    to keep a fixed orientation.
     """

flet_map/polygon_layer.py

@@ -1,11 +1,11 @@
-from typing import List, Optional
+from typing import Optional
 
 import flet as ft
 
-from .map_layer import MapLayer
-from .types import MapLatitudeLongitude
+from flet_map.map_layer import MapLayer
+from flet_map.types import MapLatitudeLongitude
 
-__all__ = ["PolygonMarker", "PolygonLayer"]
+__all__ = ["PolygonLayer", "PolygonMarker"]
 
 
 @ft.control("PolygonMarker")
@@ -14,7 +14,7 @@ class PolygonMarker(ft.Control):
     A marker for the [`PolygonLayer`][(p).].
     """
 
-    coordinates: List[MapLatitudeLongitude]
+    coordinates: list[MapLatitudeLongitude]
     """
     The points for the outline of this polygon.
     """
@@ -47,7 +47,7 @@ class PolygonMarker(ft.Control):
     border_stroke_width: ft.Number = 0.0
     """
     The width of the border outline.
-    
+
     Note:
         Must be non-negative.
     """
@@ -59,7 +59,7 @@ class PolygonMarker(ft.Control):
 
     rotate_label: bool = False
     """
-    Whether to rotate the label counter to the camera's rotation, 
+    Whether to rotate the label counter to the camera's rotation,
     to ensure it remains upright.
     """
 
@@ -75,9 +75,10 @@ class PolygonMarker(ft.Control):
 
     def before_update(self):
         super().before_update()
-        assert (
-            self.border_stroke_width >= 0
-        ), "border_stroke_width must be greater than or equal to 0"
+        assert self.border_stroke_width >= 0, (
+            f"border_stroke_width must be greater than or equal to 0, "
+            f"got {self.border_stroke_width}"
+        )
 
 
 @ft.control("PolygonLayer")
@@ -86,7 +87,7 @@ class PolygonLayer(MapLayer):
     A layer to display PolygonMarkers.
     """
 
-    polygons: List[PolygonMarker]
+    polygons: list[PolygonMarker]
     """
     A list of [`PolygonMarker`][(p).]s to display.
     """
@@ -108,14 +109,14 @@ class PolygonLayer(MapLayer):
 
     simplification_tolerance: ft.Number = 0.3
     """
-    
+
     """
 
     use_alternative_rendering: bool = False
     """
     Whether to use an alternative rendering pathway to draw polygons onto the
-    underlying `Canvas`, which can be more performant in 'some' circumstances. 
-    
+    underlying `Canvas`, which can be more performant in 'some' circumstances.
+
     This will not always improve performance, and there are other important
     considerations before enabling it. It is intended for use when prior
     profiling indicates more performance is required after other methods are

flet_map/polyline_layer.py

@@ -3,10 +3,10 @@ from typing import Optional
 
 import flet as ft
 
-from .map_layer import MapLayer
-from .types import MapLatitudeLongitude, SolidStrokePattern, StrokePattern
+from flet_map.map_layer import MapLayer
+from flet_map.types import MapLatitudeLongitude, SolidStrokePattern, StrokePattern
 
-__all__ = ["PolylineMarker", "PolylineLayer"]
+__all__ = ["PolylineLayer", "PolylineMarker"]
 
 
 @ft.control("PolylineMarker")
@@ -43,7 +43,7 @@ class PolylineMarker(ft.Control):
     stroke_width: ft.Number = 1.0
     """
     The width of the stroke.
-    
+
     Note:
         Must be non-negative.
     """
@@ -51,7 +51,7 @@ class PolylineMarker(ft.Control):
     border_stroke_width: ft.Number = 0.0
     """
     The width of the stroke with of the line border.
-    
+
     Note:
         Must be non-negative.
     """
@@ -79,10 +79,13 @@ class PolylineMarker(ft.Control):
 
     def before_update(self):
         super().before_update()
-        assert (
-            self.border_stroke_width >= 0
-        ), "border_stroke_width must be greater than or equal to 0"
-        assert self.stroke_width >= 0, "stroke_width must be greater than or equal to 0"
+        assert self.border_stroke_width >= 0, (
+            f"border_stroke_width must be greater than or equal to 0, "
+            f"got {self.border_stroke_width}"
+        )
+        assert self.stroke_width >= 0, (
+            f"stroke_width must be greater than or equal to 0, got {self.stroke_width}"
+        )
 
 
 @ft.control("PolylineLayer")
@@ -93,7 +96,7 @@ class PolylineLayer(MapLayer):
 
     polylines: list[PolylineMarker]
     """
-    List of [`PolylineMarker`][(p).]s to be drawn. 
+    List of [`PolylineMarker`][(p).]s to be drawn.
     """
 
     culling_margin: ft.Number = 10.0
@@ -104,12 +107,12 @@ class PolylineLayer(MapLayer):
     min_hittable_radius: ft.Number = 10.0
     """
     The minimum radius of the hittable area around each polyline in logical pixels.
-    
+
     The entire visible area is always hittable, but if the visible area is
     smaller than this, then this will be the hittable area.
     """
 
     simplification_tolerance: ft.Number = 0.3
     """
-    
+
     """

flet_map/rich_attribution.py

@@ -1,11 +1,11 @@
 from dataclasses import field
-from typing import List, Optional
+from typing import Optional
 
 import flet as ft
 
-from .map_layer import MapLayer
-from .source_attribution import SourceAttribution
-from .types import AttributionAlignment
+from flet_map.map_layer import MapLayer
+from flet_map.source_attribution import SourceAttribution
+from flet_map.types import AttributionAlignment
 
 __all__ = ["RichAttribution"]
 
@@ -17,11 +17,11 @@ class RichAttribution(MapLayer):
     (displayed in a popup controlled by an icon button adjacent to the images).
     """
 
-    attributions: List[SourceAttribution]
+    attributions: list[SourceAttribution]
     """
     List of attributions to display.
-    
-    [`TextSourceAttribution`][(p).]s are shown in a popup box, 
+
+    [`TextSourceAttribution`][(p).]s are shown in a popup box,
     unlike [`ImageSourceAttribution`][(p).], which are visible permanently.
     """
 
@@ -44,10 +44,12 @@ class RichAttribution(MapLayer):
         default_factory=lambda: ft.Duration()
     )
     """
-    The popup box will be open by default and be hidden this long after the map is initialised.
-    
+    The popup box will be open by default and be hidden this
+    long after the map is initialised.
+
     This is useful with certain sources/tile servers that make immediate
-    attribution mandatory and are not attributed with a permanently visible [`ImageSourceAttribution`][(p).].
+    attribution mandatory and are not attributed with a permanently
+    visible [`ImageSourceAttribution`][(p).].
     """
 
     permanent_height: ft.Number = 24.0
@@ -58,6 +60,7 @@ class RichAttribution(MapLayer):
 
     show_flutter_map_attribution: bool = True
     """
-    Whether to add an additional attribution logo and text for [`flutter-map`](https://docs.fleaflet.dev/),
+    Whether to add an additional attribution logo and text
+    for [`flutter-map`](https://docs.fleaflet.dev/),
     on which 'flet-map' package is based for map-renderings.
     """

flet_map/simple_attribution.py

@@ -1,9 +1,9 @@
 from dataclasses import field
-from typing import Union
+from typing import Optional, Union
 
 import flet as ft
 
-from .map_layer import MapLayer
+from flet_map.map_layer import MapLayer
 
 __all__ = ["SimpleAttribution"]
 
@@ -17,19 +17,17 @@ class SimpleAttribution(MapLayer):
     text: Union[str, ft.Text]
     """
     The attribution message to be displayed.
-    
-    Value is of type `str` and `ft.Text`.
     """
 
-    alignment: ft.Alignment = field(default_factory=lambda: ft.Alignment.bottom_right())
+    alignment: ft.Alignment = field(default_factory=lambda: ft.Alignment.BOTTOM_RIGHT)
     """
     The alignment of this attribution on the map.
     """
 
     bgcolor: ft.ColorValue = ft.Colors.SURFACE
     """
-    The color of the box containing the `text`.
+    The color of the box containing the [`text`][..].
     """
 
-    on_click: ft.OptionalControlEventHandler["SimpleAttribution"] = None
+    on_click: Optional[ft.ControlEventHandler["SimpleAttribution"]] = None
     """Fired when this attribution is clicked/pressed."""

flet_map/source_attribution.py

@@ -6,7 +6,7 @@ import flet as ft
 __all__ = ["ImageSourceAttribution", "SourceAttribution", "TextSourceAttribution"]
 
 
-@dataclass(kw_only=True)
+@dataclass
 class SourceAttribution(ft.BaseControl):
     """
     Abstract class for source attribution controls:
@@ -19,8 +19,10 @@ class SourceAttribution(ft.BaseControl):
 @ft.control("ImageSourceAttribution")
 class ImageSourceAttribution(SourceAttribution):
     """
-    An image attribution permanently displayed adjacent to the open/close icon of a [`RichAttribution`][(p).] control.
-    For it to be displayed, it should be part of a [`RichAttribution.attributions`][(p).] list.
+    An image attribution permanently displayed adjacent to the
+    open/close icon of a [`RichAttribution`][(p).] control.
+    For it to be displayed, it should be part of a
+    [`RichAttribution.attributions`][(p).] list.
 
     Raises:
         AssertionError: If the [`image`][(c).] is not visible.
@@ -29,7 +31,7 @@ class ImageSourceAttribution(SourceAttribution):
     image: ft.Image
     """
     The `Image` to be displayed.
-    
+
     Note:
         Must be provided and visible.
     """
@@ -37,13 +39,14 @@ class ImageSourceAttribution(SourceAttribution):
     height: ft.Number = 24.0
     """
     The height of the image.
-    Should be the same as [`RichAttribution.permanent_height`][(p).], otherwise layout issues may occur.
+    Should be the same as [`RichAttribution.permanent_height`][(p).],
+    otherwise layout issues may occur.
     """
 
     tooltip: Optional[str] = None
     """Tooltip text to be displayed when the image is hovered over."""
 
-    on_click: ft.OptionalControlEventHandler["ImageSourceAttribution"] = None
+    on_click: Optional[ft.ControlEventHandler["ImageSourceAttribution"]] = None
     """Fired when this attribution is clicked/pressed."""
 
     def before_update(self):
@@ -55,7 +58,8 @@ class ImageSourceAttribution(SourceAttribution):
 class TextSourceAttribution(SourceAttribution):
     """
     A text source attribution displayed on the Map.
-    For it to be displayed, it should be part of a [`RichAttribution.attributions`][(p).] list.
+    For it to be displayed, it should be part of a
+    [`RichAttribution.attributions`][(p).] list.
     """
 
     text: str
@@ -69,5 +73,5 @@ class TextSourceAttribution(SourceAttribution):
     Whether to add the '©' character to the start of [`text`][..] automatically.
     """
 
-    on_click: ft.OptionalControlEventHandler["TextSourceAttribution"] = None
+    on_click: Optional[ft.ControlEventHandler["TextSourceAttribution"]] = None
     """Fired when this attribution is clicked/pressed."""

flet_map/tile_layer.py

@@ -1,10 +1,10 @@
 from dataclasses import field
-from typing import Dict, List, Optional
+from typing import Optional
 
 import flet as ft
 
-from .map_layer import MapLayer
-from .types import (
+from flet_map.map_layer import MapLayer
+from flet_map.types import (
     FadeInTileDisplay,
     MapLatitudeLongitudeBounds,
     TileDisplay,
@@ -20,17 +20,20 @@ class TileLayer(MapLayer):
     Displays square raster images in a continuous grid,
     sourced from the provided [`url_template`][(c).] and [`fallback_url`][(c).].
 
-    Typically the first layer to be added to a [`Map`][(p).], as it provides the tiles on which
+    Typically the first layer to be added to a [`Map`][(p).],
+    as it provides the tiles on which
     other layers are displayed.
 
     Raises:
         AssertionError: If one or more of the following is negative:
-            [`tile_size`][(c).], [`min_native_zoom`][(c).], [`max_native_zoom`][(c).], [`zoom_offset`][(c).], [`max_zoom`][(c).], [`min_zoom`][(c).]
+            [`tile_size`][(c).], [`min_native_zoom`][(c).],
+            [`max_native_zoom`][(c).], [`zoom_offset`][(c).],
+            [`max_zoom`][(c).], [`min_zoom`][(c).]
     """
 
     url_template: str
     """
-    The URL template is a string that contains placeholders, 
+    The URL template is a string that contains placeholders,
     which, when filled in, create a URL/URI to a specific tile.
     """
 
@@ -38,20 +41,21 @@ class TileLayer(MapLayer):
     """
     Fallback URL template, used if an error occurs when fetching tiles from
     the [`url_template`][..].
-    
+
     Note that specifying this (non-none) will result in tiles not being cached
     in memory. This is to avoid issues where the [`url_template`][..] is flaky, to
     prevent different tilesets being displayed at the same time.
-    
-    It is expected that this follows the same retina support behaviour as [`url_template`][..].
+
+    It is expected that this follows the same retina support behaviour
+    as [`url_template`][..].
     """
 
-    subdomains: List[str] = field(default_factory=lambda: ["a", "b", "c"])
+    subdomains: list[str] = field(default_factory=lambda: ["a", "b", "c"])
     """
     List of subdomains used in the URL template.
 
-    For example, if [`subdomains`][..] is set to `["a", "b", "c"]` and the 
-    `url_template` is `"https://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png"`, 
+    For example, if [`subdomains`][..] is set to `["a", "b", "c"]` and the
+    `url_template` is `"https://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png"`,
     the resulting tile URLs will be:
 
     - `"https://a.tile.openstreetmap.org/{z}/{x}/{y}.png"`
@@ -61,7 +65,7 @@ class TileLayer(MapLayer):
 
     tile_bounds: Optional[MapLatitudeLongitudeBounds] = None
     """
-    Defines the bounds of the map. 
+    Defines the bounds of the map.
     Only tiles that fall within these bounds will be loaded.
     """
 
@@ -69,7 +73,7 @@ class TileLayer(MapLayer):
     """
     The size in pixels of each tile image.
     Should be a positive power of 2.
-    
+
     Note:
         Must be greater than or equal to `0.0`.
     """
@@ -80,10 +84,10 @@ class TileLayer(MapLayer):
 
     Tiles from below this zoom level will not be displayed, instead tiles at
     this zoom level will be displayed and scaled.
-    
+
     This should usually be 0 (as default), as most tile sources will support
     zoom levels onwards from this.
-    
+
     Note:
         Must be greater than or equal to `0.0`.
     """
@@ -94,30 +98,32 @@ class TileLayer(MapLayer):
 
     Tiles from above this zoom level will not be displayed, instead tiles at
     this zoom level will be displayed and scaled.
-    
+
     Most tile servers support up to zoom level `19`, which is the default.
     Otherwise, this should be specified.
-    
+
     Note:
         Must be greater than or equal to `0.0`.
     """
 
     zoom_reverse: bool = False
     """
-    Whether the zoom number used in tile URLs will be reversed (`max_zoom - zoom` instead of `zoom`).
+    Whether the zoom number used in tile URLs will be reversed
+    (`max_zoom - zoom` instead of `zoom`).
     """
 
     zoom_offset: ft.Number = 0.0
     """
     The zoom number used in tile URLs will be offset with this value.
-    
+
     Note:
         Must be greater than or equal to `0.0`.
     """
 
     keep_buffer: int = 2
     """
-    When panning the map, keep this many rows and columns of tiles before unloading them.
+    When panning the map, keep this many rows and columns of
+    tiles before unloading them.
     """
 
     pan_buffer: int = 1
@@ -137,14 +143,15 @@ class TileLayer(MapLayer):
     enable_retina_mode: bool = False
     """
     Whether to enable retina mode.
-    Retina mode improves the resolution of map tiles, particularly on high density displays.
+    Retina mode improves the resolution of map tiles, particularly on
+    high density displays.
     """
 
-    additional_options: Dict[str, str] = field(default_factory=dict)
+    additional_options: dict[str, str] = field(default_factory=dict)
     """
     Static information that should replace placeholders in the [`url_template`][..].
     Applying API keys, for example, is a good usecase of this parameter.
-    
+
     Example:
         ```python
         TileLayer(
@@ -162,12 +169,12 @@ class TileLayer(MapLayer):
     The maximum zoom level up to which this layer will be displayed (inclusive).
     The main usage for this property is to display a different `TileLayer`
     when zoomed far in.
-    
+
     Prefer [`max_native_zoom`][..] for setting the maximum zoom level supported by the
-    tile source. 
-    
+    tile source.
+
     Typically set to infinity so that there are tiles always displayed.
-    
+
     Note:
         Must be greater than or equal to `0.0`.
     """
@@ -176,7 +183,7 @@ class TileLayer(MapLayer):
     """
     The minimum zoom level at which this layer is displayed (inclusive).
     Typically `0.0`.
-    
+
     Note:
         Must be greater than or equal to `0.0`.
     """
@@ -184,21 +191,21 @@ class TileLayer(MapLayer):
     error_image_src: Optional[str] = None
     """
     The source of the tile image to show in place of the tile that failed to load.
-    
+
     See [`on_image_error`][..] property for details on the error.
     """
 
-    evict_error_tile_strategy: Optional[
-        TileLayerEvictErrorTileStrategy
-    ] = TileLayerEvictErrorTileStrategy.NONE
+    evict_error_tile_strategy: Optional[TileLayerEvictErrorTileStrategy] = (
+        TileLayerEvictErrorTileStrategy.NONE
+    )
     """
-    If a tile was loaded with error, 
+    If a tile was loaded with error,
     the tile provider will be asked to evict the image based on this strategy.
     """
 
     display_mode: TileDisplay = field(default_factory=lambda: FadeInTileDisplay())
     """
-    
+
     Defines how tiles are displayed on the map.
     """
 
@@ -207,11 +214,12 @@ class TileLayer(MapLayer):
     The package name of the user agent.
     """
 
-    on_image_error: ft.OptionalControlEventHandler["TileLayer"] = None
+    on_image_error: Optional[ft.ControlEventHandler["TileLayer"]] = None
     """
     Fires if an error occurs when fetching the tiles.
-    
-    Event handler argument `data` property contains information about the error.
+
+    Event handler argument [`data`][flet.Event.data] property contains
+    information about the error.
     """
 
     def before_update(self):
@@ -220,10 +228,12 @@ class TileLayer(MapLayer):
             f"tile_size must be greater than or equal to 0, got {self.tile_size}"
         )
         assert self.min_native_zoom >= 0, (
-            f"min_native_zoom must be greater than or equal to 0, got {self.min_native_zoom}"
+            f"min_native_zoom must be greater than or equal to 0, "
+            f"got {self.min_native_zoom}"
         )
         assert self.max_native_zoom >= 0, (
-            f"max_native_zoom must be greater than or equal to 0, got {self.max_native_zoom}"
+            f"max_native_zoom must be greater than or equal to 0, "
+            f"got {self.max_native_zoom}"
         )
         assert self.zoom_offset >= 0, (
             f"zoom_offset must be greater than or equal to 0, got {self.zoom_offset}"