marianoguerra/pure-py/error

README
V
check
V
check_program
V
parse
V
run
V
run_with
V
sieve
V
source_tree
V
source_tree_from
V
unparse

marianoguerra/pure-py/error does not have a README file

PurePyError

pub(all) suberror PurePyError {
  PurePyError(Diagnostic)
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

The one error this module raises. Everything that can reject carries a Diagnostic, so a caller never has to match on several error types to decide an exit code.

Diagnostic

source

pub(all) struct Diagnostic {
  kind : Kind
  span : @marianoguerra/pure-py/basic.Span
Span?
  in_module : String?
  related : Array[(@marianoguerra/pure-py/basic.Span
Span, String)]
  file : String?
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

A rejection: what, where, in which module, and what else the reader should look at.

related is this port's addition. The reference records one position; a person reading 'g' captured by previous statement, reassigned here wants to see the statement that captured it too. short never prints it, so the comparison with the reference is unaffected.

Diagnostic::as_parse_error

source

fn Diagnostic::as_parse_error(self : Diagnostic) -> Diagnostic

The same rejection, worded as the reference words a Python syntax error found while LOADING a module: parse error: <msg>. syntax.py lets ast.parse raise and the message reaches the user through check_program.py's load, which prefixes it.

Diagnostic::at_path

source

fn Diagnostic::at_path(self : Diagnostic, path : String) -> Diagnostic

The same rejection, reported against a file, with its position and exit code unchanged: what the reference does to a rejection in a module of a program.

Diagnostic::attribute_to

source

fn Diagnostic::attribute_to(self : Diagnostic, q : String) -> Diagnostic

Record which module a rejection came from, if it does not already say.

The innermost module wins: a module that fails while being imported keeps its own name, and the importer's path prefix is what check-program adds.

Diagnostic::code

source

fn Diagnostic::code(self : Diagnostic) -> String?

A short, stable code to search for.

Diagnostic::exit_code

source

fn Diagnostic::exit_code(self : Diagnostic) -> Int

The exit code this rejection carries, as implementation-plan.md §2.1 and the reference's scripts fix them.

Diagnostic::help

source

fn Diagnostic::help(self : Diagnostic) -> String?

What a person is likely to want to do about it.

Only where the message does not already say. A rule that is surprising -- the capture rules, and the two "not a first-class value" ones -- earns a line; "duplicate field name 'x'" does not.

Diagnostic::message

source

fn Diagnostic::message(self : Diagnostic) -> String

The message, exactly as the reference prints it after the position.

Diagnostic::new

source

fn Diagnostic::new(kind : Kind, span? : @marianoguerra/pure-py/basic.Span
Span, in_module? : String, related? : Array[(@marianoguerra/pure-py/basic.Span
Span, String)]) -> Diagnostic

Diagnostic::raise_

source

fn Diagnostic::raise_(self : Diagnostic) -> PurePyError

Raise this diagnostic.

Diagnostic::short

source

fn Diagnostic::short(self : Diagnostic, path : String, source? : @marianoguerra/pure-py/basic.Source
Source) -> String

path:line:col: message, or path: message when there is no position -- the format syntax.py and check_module.py print.

The column is in UTF-8 bytes when a source is given, because that is what CPython's col_offset counts and what the reference therefore prints. Without a source the stored code-point column is used, which differs only on a line with a non-ASCII character before the error.

Diagnostic::stage

source

fn Diagnostic::stage(self : Diagnostic) -> Stage

Diagnostic::to_report

source

fn Diagnostic::to_report(self : Diagnostic, source : @marianoguerra/error-report.SourceId
SourceId) -> @marianoguerra/error-report.Report
Report

The ONE place this module names error-report.

Everything below error produces a Diagnostic, which is this module's own type and carries no rendering. This function is the whole bridge, so that swapping the renderer is a one-function change and so that tools/boundary-check.sh can assert that nothing else links it.

The rendering adds what the reference does not have and a person wants: a second span for the statement that a message refers to but does not point at, a help line where the fix is not obvious from the message, and a stable code to search for.

Diagnostic::with_related

source

fn Diagnostic::with_related(self : Diagnostic, span : @marianoguerra/pure-py/basic.Span
Span, message : String) -> Diagnostic

A diagnostic with a second place to look.

Kind

source

pub(all) enum Kind {
  PythonSyntax(msg~ : String)
  Prohibited(msg~ : String)
  IllFormed(Reason)
  Program(msg~ : String)
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

What went wrong, in enough detail to reproduce the reference's message exactly. Every arm's message is compared against the reference's, so a wording change here is a conformance failure and not a matter of taste.

Reason

source

pub(all) enum Reason {
  DuplicateField(x~ : String, c~ : String)
  InheritedField(x~ : String, c~ : String, d~ : String)
  NotTypeExpression(e~ : String)
  UndefinedVariable(x~ : String)
  UnassignedVariable(x~ : String)
  PossiblyUnassigned(x~ : String, declared_in_branch~ : Bool)
  UnboundName(x~ : String)
  Redeclaration(x~ : String)
  UndeclaredAssignment(x~ : String)
  AssignmentBeforeDeclaration(x~ : String)
  Reassignment(x~ : String)
  MaybeAssigned(x~ : String)
  CapturedGeneratorVariable(x~ : String)
  UnreachableStatement
  ConstructorArityMismatch(c~ : String, expected~ : Int, got~ : Int)
  UnknownConstructorKeyword(c~ : String, xs~ : Array[String])
  PatternArityMismatch(c~ : String, expected~ : Int, got~ : Int)
  NotPredefinedName(x~ : String)
  RangePattern
  CyclicTypeAlias(x~ : String)
  NotClass(q~ : String)
  ClassArityMismatch(q~ : String, expected~ : Int, given~ : Int)
  TypeAliasArityMismatch(q~ : String, expected~ : Int, given~ : Int)
  UnknownFieldInPattern(c~ : String, xs~ : Array[String])
  DuplicateMember(x~ : String, q~ : String)
  SubmoduleNotImported(q~ : String)
  UnassignedMember(x~ : String, q~ : String)
  TopLevelAssertFalse
  UnknownModule(q~ : String)
  DuplicateImportedName(x~ : String)
  UnknownMember(x~ : String, q~ : String)
  ModuleAsValue(q~ : String)
  ImportOfContainedModule(q~ : String, q_~ : String, from_import~ : String)
  PredefinedNameAsValue(q~ : String)
  TypeParameterAsValue(x~ : String)
  TypeSchemeAsValue(q~ : String)
  NoTypeArgument(alpha~ : String)
  TypeAliasAsValue(q~ : String)
  ClassAsValue(q~ : String)
  NoBinaryOverload(op~ : String, sigma~ : String, sigma_~ : String)
  NoUnaryOverload(op~ : String, sigma~ : String)
  NotCallable(tau~ : String)
  KeywordArgumentsNotConstructor
  CallArityMismatch(expected~ : Int, given~ : Int)
  TypeMismatch(expected~ : String, actual~ : String)
  LambdaTypeMismatch(expected~ : String, arity~ : Int?)
  NotSubscriptable(tau~ : String)
  TupleIndexOutOfRange(index~ : @moonbitlang/core/bigint.BigInt
BigInt, length~ : Int)
  UnreachableCase(pattern~ : String)
  PatternClassUndetermined(c~ : String, tau~ : String)
  SequenceKindMismatch(kind~ : String, tau~ : String, other~ : String)
  NotIterable(tau~ : String)
  UnknownField(c~ : String, x~ : String)
  NoneResult
  NotSynthesised
  NoAttributes(tau~ : String)
  BareReturn(tau~ : String)
  MissingReturn(x~ : String, tau~ : String)
  MissingReturnAssertion
  MissingReturnMatchPartial(remaining~ : String)
  MypyCompatibility(Reason)
  UnknownMethod(tau~ : String, x~ : String)
  TupleSliceBounds(tau~ : String)
  TupleSliceStepZero
  LambdaDefaultArguments
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Why a module is not well formed.

One arm per class in the reference's reasons.py, carrying the same fields, and message reproduces the Python f-strings character for character: these are the .error.expected files of the conformance suite's static buckets, so the wording is fixed by the oracle and not by taste.

A type in a message is carried already RENDERED, as the string render in lib/types makes of it: this package sits below the type checker and knows nothing of types but how they read.

Reason::code

source

fn Reason::code(self : Reason) -> String

A short, stable code for a reason, for --error-format json and for a person searching: purepy::unassigned-variable.

Reason::message

source

fn Reason::message(self : Reason) -> String

The message, exactly as reasons.py writes it.

Stage

source

pub(all) enum Stage {
  Syntax
  Prohibited
  IllFormedModule
  IllFormedProgram
  Abort
  Stuck
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Where a rejection came from, which is the same thing as which exit code it carries. The reference has one script per stage; this port has one type.

ill_formed

source

fn ill_formed(reason : Reason, span? : @marianoguerra/pure-py/basic.Span
Span) -> PurePyError

Reject a module: exit 3, with the reference's own wording.

ill_formed_program

source

fn ill_formed_program(msg : String) -> PurePyError

Reject a program: exit 4.

syntax_error

source

fn syntax_error(msg : String, span : @marianoguerra/pure-py/basic.Span
Span) -> PurePyError

Raise a Python syntax error at span.

Source Files

Install

Download zip

PurePy (a pure functional subset of Python 3.12): tokenizer, parser, checker and interpreter

pythonparserinterpreterpurepy

marianoguerra

Apache-2.0

github.com/marianoguerra/pure-py-mb

Updated 9 days ago

246 downloads

Site source Report issue Modules Skills CLI Build queue Statistics

#PurePyError

#Diagnostic

#Diagnostic::as_parse_error

#Diagnostic::at_path

#Diagnostic::attribute_to

#Diagnostic::code

#Diagnostic::exit_code

#Diagnostic::help

#Diagnostic::message

#Diagnostic::new

#Diagnostic::raise_

#Diagnostic::short

#Diagnostic::stage

#Diagnostic::to_report

#Diagnostic::with_related

#Kind

#Reason

#Reason::code

#Reason::message

#Stage

#ill_formed

#ill_formed_program

#syntax_error

Source Files

PurePyError

Diagnostic

Diagnostic::as_parse_error

Diagnostic::at_path

Diagnostic::attribute_to

Diagnostic::code

Diagnostic::exit_code

Diagnostic::help

Diagnostic::message

Diagnostic::new

Diagnostic::raise_

Diagnostic::short

Diagnostic::stage

Diagnostic::to_report

Diagnostic::with_related

Kind

Reason

Reason::code

Reason::message

Stage

ill_formed

ill_formed_program

syntax_error