funground 0.1.0__py3-none-any.whl

funground/__init__.py

@@ -0,0 +1,449 @@
+"""A tiny teaching-friendly visual programming wrapper around pygame-ce.
+
+Typical use::
+
+    import funground as f
+
+    x = 50
+
+    def setup():
+        f.size(640, 400)
+
+    def draw():
+        global x
+        f.background("white")
+        f.circle(x, f.height / 2, 40)
+        x += 2
+
+    f.run()
+"""
+
+from . import api as _api
+from .api import (
+    FormattedString,
+    Vector,
+    apply_filter,
+    apply_matrix,
+    arc,
+    background,
+    begin_contour,
+    begin_shape,
+    bezier,
+    bezier_point,
+    bezier_tangent,
+    bezier_vertex,
+    blend_mode,
+    circle,
+    clear,
+    clip,
+    cmyk,
+    color,
+    color_mode,
+    constrain,
+    create_button,
+    create_checkbox,
+    create_graphics,
+    create_slider,
+    cursor,
+    curve,
+    curve_point,
+    curve_tangent,
+    curve_tightness,
+    curve_vertex,
+    day,
+    degrees,
+    distance,
+    draw_path,
+    ellipse,
+    ellipse_mode,
+    end_contour,
+    end_shape,
+    exit,
+    fill,
+    filter,
+    frame_rate,
+    full_screen,
+    get,
+    hour,
+    hsb,
+    hsl,
+    image,
+    image_mode,
+    is_looping,
+    key_down,
+    hide_layer,
+    layer,
+    lerp,
+    lerp_color,
+    line,
+    linear_gradient,
+    load_font,
+    load_image,
+    load_pixels,
+    load_sound,
+    create_sound,
+    tone,
+    note,
+    pluck,
+    melody,
+    sequence,
+    mix,
+    note_to_frequency,
+    frequency_to_note,
+    chord_notes,
+    microphone,
+    microphones,
+    ragas,
+    raga,
+    talas,
+    tala_info,
+    tala,
+    drone,
+    match_ragas,
+    draw_wave,
+    draw_spectrum,
+    spectrogram,
+    draw_pitch_line,
+    load_svg,
+    loop,
+    mag,
+    map_range,
+    mark,
+    keep,
+    variations,
+    millis,
+    minute,
+    miter_limit,
+    month,
+    new_page,
+    no_clip,
+    no_cursor,
+    no_dash,
+    no_fill,
+    no_loop,
+    no_shadow,
+    no_smooth,
+    no_stroke,
+    no_erase,
+    no_tint,
+    noise,
+    noise_detail,
+    noise_seed,
+    norm,
+    erase,
+    opacity,
+    page_count,
+    page_size,
+    area,
+    grid,
+    inch,
+    mm,
+    path,
+    point,
+    polygon,
+    pop,
+    push,
+    quad,
+    quadratic_vertex,
+    radial_gradient,
+    radians,
+    random,
+    random_number,
+    random_choice,
+    random_gaussian,
+    random_seed,
+    rect,
+    rect_mode,
+    redraw,
+    reset_matrix,
+    resize_canvas,
+    rotate,
+    run,
+    save,
+    save_frames,
+    save_gif,
+    save_movie,
+    frame_duration,
+    saved_state,
+    scale,
+    second,
+    set,
+    set_pixel,
+    shadow,
+    shear_x,
+    shear_y,
+    show,
+    show_layer,
+    size,
+    smooth,
+    square,
+    stop,
+    stroke,
+    stroke_cap,
+    stroke_dash,
+    stroke_join,
+    stroke_width,
+    svg_paths,
+    text,
+    text_align,
+    text_ascent,
+    text_box,
+    text_descent,
+    text_font,
+    text_leading,
+    text_path,
+    text_to_points,
+    current_font,
+    text_size,
+    text_style,
+    text_tracking,
+    text_fallback,
+    system_font,
+    text_features,
+    font_variations,
+    text_width,
+    fit_text_size,
+    text_on_path,
+    tint,
+    translate,
+    triangle,
+    update_pixels,
+    vertex,
+    year,
+)
+
+__version__ = "0.1.0"
+
+# The public names: the contract (tests/test_api_contract.py), the reference and the gallery cover each one.
+_PUBLIC_NAMES = [
+    "FormattedString",
+    "Vector",
+    "apply_matrix",
+    "arc",
+    "background",
+    "begin_contour",
+    "begin_shape",
+    "bezier",
+    "bezier_point",
+    "bezier_tangent",
+    "bezier_vertex",
+    "blend_mode",
+    "circle",
+    "clear",
+    "clip",
+    "cmyk",
+    "color",
+    "color_mode",
+    "constrain",
+    "create_button",
+    "create_checkbox",
+    "create_graphics",
+    "create_slider",
+    "cursor",
+    "curve",
+    "curve_point",
+    "curve_tangent",
+    "curve_tightness",
+    "curve_vertex",
+    "day",
+    "degrees",
+    "distance",
+    "draw_path",
+    "ellipse",
+    "ellipse_mode",
+    "end_contour",
+    "end_shape",
+    "exit",
+    "fill",
+    "filter",
+    "apply_filter",
+    "frame_rate",
+    "full_screen",
+    "get",
+    "hour",
+    "hsb",
+    "hsl",
+    "image",
+    "image_mode",
+    "is_looping",
+    "key_down",
+    "hide_layer",
+    "layer",
+    "lerp",
+    "lerp_color",
+    "line",
+    "linear_gradient",
+    "load_font",
+    "load_image",
+    "load_pixels",
+    "load_sound",
+    "create_sound",
+    "tone",
+    "note",
+    "pluck",
+    "melody",
+    "sequence",
+    "mix",
+    "note_to_frequency",
+    "frequency_to_note",
+    "chord_notes",
+    "microphone",
+    "microphones",
+    "ragas",
+    "raga",
+    "talas",
+    "tala_info",
+    "tala",
+    "drone",
+    "match_ragas",
+    "draw_wave",
+    "draw_spectrum",
+    "spectrogram",
+    "draw_pitch_line",
+    "load_svg",
+    "loop",
+    "mag",
+    "map_range",
+    "mark",
+    "keep",
+    "variations",
+    "millis",
+    "minute",
+    "miter_limit",
+    "month",
+    "new_page",
+    "no_clip",
+    "no_cursor",
+    "no_dash",
+    "no_fill",
+    "no_loop",
+    "no_shadow",
+    "no_smooth",
+    "no_stroke",
+    "no_erase",
+    "no_tint",
+    "erase",
+    "noise",
+    "noise_detail",
+    "noise_seed",
+    "norm",
+    "opacity",
+    "page_count",
+    "page_size",
+    "area",
+    "grid",
+    "inch",
+    "mm",
+    "path",
+    "point",
+    "polygon",
+    "pop",
+    "push",
+    "quad",
+    "quadratic_vertex",
+    "radial_gradient",
+    "radians",
+    "random",
+    "random_number",
+    "random_choice",
+    "random_gaussian",
+    "random_seed",
+    "rect",
+    "rect_mode",
+    "redraw",
+    "reset_matrix",
+    "resize_canvas",
+    "rotate",
+    "run",
+    "save",
+    "save_frames",
+    "save_gif",
+    "save_movie",
+    "frame_duration",
+    "saved_state",
+    "scale",
+    "second",
+    "set",
+    "set_pixel",
+    "shadow",
+    "shear_x",
+    "shear_y",
+    "show",
+    "show_layer",
+    "size",
+    "smooth",
+    "square",
+    "stop",
+    "stroke",
+    "stroke_cap",
+    "stroke_dash",
+    "stroke_join",
+    "stroke_width",
+    "svg_paths",
+    "text",
+    "text_align",
+    "text_ascent",
+    "text_box",
+    "text_descent",
+    "text_font",
+    "text_leading",
+    "text_path",
+    "text_to_points",
+    "current_font",
+    "text_size",
+    "text_style",
+    "text_tracking",
+    "text_fallback",
+    "system_font",
+    "text_features",
+    "font_variations",
+    "text_width",
+    "fit_text_size",
+    "text_on_path",
+    "tint",
+    "translate",
+    "triangle",
+    "update_pixels",
+    "vertex",
+    "year",
+    "width",
+    "height",
+    "mouse_x",
+    "mouse_y",
+    "is_mouse_pressed",
+    "pmouse_x",
+    "pmouse_y",
+    "mouse_button",
+    "key",
+    "key_code",
+    "is_key_pressed",
+    "frame_count",
+    "delta_time",
+    "pixels",
+    "ground",
+]
+
+
+# What ``from funground import *`` brings in (D-088, S-176): every public name except four that would hide Python's
+# own: set, filter and exit are built-ins, and random is the standard-library module. There they are set_pixel(),
+# apply_filter(), stop() and random_number(), the same functions under names that hide nothing (STAR_NAMES_FOR).
+# tests/test_global_style.py keeps the list free of any built-in or standard-library name.
+STAR_NAMES_FOR = {"exit": "stop", "filter": "apply_filter", "random": "random_number", "set": "set_pixel"}
+STAR_LEAVES_OUT = tuple(sorted(STAR_NAMES_FOR))
+__all__ = [name for name in _PUBLIC_NAMES if name not in STAR_LEAVES_OUT]
+
+# D-016: v0.5's live value mouse_pressed became is_mouse_pressed, because mouse_pressed() is
+# now the name of the callback (as in p5). The old name fails with a pointer to the new one.
+_RENAMED = {
+    "mouse_pressed": "f.mouse_pressed was renamed to f.is_mouse_pressed (True while a mouse button is "
+                     "held). To react to a click, define a function called mouse_pressed() in your sketch.",
+}
+
+
+def __getattr__(name: str):
+    """Expose live values without copying stale integers into this module."""
+    if name in _api.LIVE_NAMES:
+        return _api.live_value(name)
+    if name in _RENAMED:
+        raise AttributeError(_RENAMED[name])
+    raise AttributeError(f"module {__name__!r} has no attribute {name!r}")