Language.Python.Optics

Optics for manipulating Python syntax trees

Documentation

module Language.Python.Optics.Validated

Identifiers

module Language.Python.Optics.Idents

Indentation

module Language.Python.Optics.Indents

Newlines

module Language.Python.Optics.Newlines

Simple statements

Assignment

assignTargets :: Traversal (Expr v a) (Expr '[] a) (Ident v a) (Ident '[] a)

Traversal targeting the variables that would modified as a result of an assignment

Here are some examples of assignment targets:

a = b
^

(a, b, c) = d
 ^  ^  ^

[a, b, *c] = d
 ^  ^   ^

These expressions have variables on the left hand side of the =, but those variables don't count as assignment targets:

a[b] = c

a(b) = c

{a: b} = c

Compound statements

class HasCompoundStatement s where

Methods

_CompoundStatement :: Prism (s v a) (s '[] a) (CompoundStatement v a) (CompoundStatement '[] a)

Instances

HasCompoundStatement CompoundStatement

Defined in Language.Python.Optics

Methods

_CompoundStatement :: Prism (CompoundStatement v a) (CompoundStatement [] a) (CompoundStatement v a) (CompoundStatement [] a)

HasCompoundStatement Statement

Defined in Language.Python.Optics

Methods

_CompoundStatement :: Prism (Statement v a) (Statement [] a) (CompoundStatement v a) (CompoundStatement [] a)

Function definitions

class HasFundef s where

Methods

_Fundef :: Prism (s v a) (s '[] a) (Fundef v a) (Fundef '[] a)

Instances

HasFundef CompoundStatement

Defined in Language.Python.Optics

Methods

_Fundef :: Prism (CompoundStatement v a) (CompoundStatement [] a) (Fundef v a) (Fundef [] a)

HasFundef Statement

Defined in Language.Python.Optics

Methods

_Fundef :: Prism (Statement v a) (Statement [] a) (Fundef v a) (Fundef [] a)

HasFundef Fundef

Defined in Language.Python.Optics

Methods

_Fundef :: Prism (Fundef v a) (Fundef [] a) (Fundef v a) (Fundef [] a)

Class defintions

class HasClassDef s where

Methods

_ClassDef :: Prism (s v a) (s '[] a) (ClassDef v a) (ClassDef '[] a)

Instances

HasClassDef CompoundStatement

Defined in Language.Python.Optics

Methods

_ClassDef :: Prism (CompoundStatement v a) (CompoundStatement [] a) (ClassDef v a) (ClassDef [] a)

HasClassDef Statement

Defined in Language.Python.Optics

Methods

_ClassDef :: Prism (Statement v a) (Statement [] a) (ClassDef v a) (ClassDef [] a)

HasClassDef ClassDef

Defined in Language.Python.Optics

Methods

_ClassDef :: Prism (ClassDef v a) (ClassDef [] a) (ClassDef v a) (ClassDef [] a)

while statements

class HasWhile s where

Methods

_While :: Prism (s v a) (s '[] a) (While v a) (While '[] a)

Instances

HasWhile CompoundStatement

Defined in Language.Python.Optics

Methods

_While :: Prism (CompoundStatement v a) (CompoundStatement [] a) (While v a) (While [] a)

HasWhile Statement

Defined in Language.Python.Optics

Methods

_While :: Prism (Statement v a) (Statement [] a) (While v a) (While [] a)

HasWhile While

Defined in Language.Python.Optics

Methods

_While :: Prism (While v a) (While [] a) (While v a) (While [] a)

for statements

class HasFor s where

Methods

_For :: Prism (s v a) (s '[] a) (For v a) (For '[] a)

Instances

HasFor CompoundStatement

Defined in Language.Python.Optics

Methods

_For :: Prism (CompoundStatement v a) (CompoundStatement [] a) (For v a) (For [] a)

HasFor Statement

Defined in Language.Python.Optics

Methods

_For :: Prism (Statement v a) (Statement [] a) (For v a) (For [] a)

HasFor For

Defined in Language.Python.Optics

Methods

_For :: Prism (For v a) (For [] a) (For v a) (For [] a)

with statements

class HasWith s where

Methods

_With :: Prism (s v a) (s '[] a) (With v a) (With '[] a)

Instances

HasWith CompoundStatement

Defined in Language.Python.Optics

Methods

_With :: Prism (CompoundStatement v a) (CompoundStatement [] a) (With v a) (With [] a)

HasWith Statement

Defined in Language.Python.Optics

Methods

_With :: Prism (Statement v a) (Statement [] a) (With v a) (With [] a)

HasWith With

Defined in Language.Python.Optics

Methods

_With :: Prism (With v a) (With [] a) (With v a) (With [] a)

if statements

class HasIf s where

Methods

_If :: Prism (s v a) (s '[] a) (If v a) (If '[] a)

Instances

HasIf CompoundStatement

Defined in Language.Python.Optics

Methods

_If :: Prism (CompoundStatement v a) (CompoundStatement [] a) (If v a) (If [] a)

HasIf Statement

Defined in Language.Python.Optics

Methods

_If :: Prism (Statement v a) (Statement [] a) (If v a) (If [] a)

HasIf If

Defined in Language.Python.Optics

Methods

_If :: Prism (If v a) (If [] a) (If v a) (If [] a)

_Elif :: Iso' (Elif v a) (Indents a, [Whitespace], Expr v a, Suite v a)

try statements

class HasTryExcept s where

Methods

_TryExcept :: Prism (s v a) (s '[] a) (TryExcept v a) (TryExcept '[] a)

Instances

HasTryExcept CompoundStatement

Defined in Language.Python.Optics

Methods

_TryExcept :: Prism (CompoundStatement v a) (CompoundStatement [] a) (TryExcept v a) (TryExcept [] a)

HasTryExcept Statement

Defined in Language.Python.Optics

Methods

_TryExcept :: Prism (Statement v a) (Statement [] a) (TryExcept v a) (TryExcept [] a)

HasTryExcept TryExcept

Defined in Language.Python.Optics

Methods

_TryExcept :: Prism (TryExcept v a) (TryExcept [] a) (TryExcept v a) (TryExcept [] a)

class HasTryFinally s where

Methods

_TryFinally :: Prism (s v a) (s '[] a) (TryFinally v a) (TryFinally '[] a)

Instances

HasTryFinally CompoundStatement

Defined in Language.Python.Optics

Methods

_TryFinally :: Prism (CompoundStatement v a) (CompoundStatement [] a) (TryFinally v a) (TryFinally [] a)

HasTryFinally Statement

Defined in Language.Python.Optics

Methods

_TryFinally :: Prism (Statement v a) (Statement [] a) (TryFinally v a) (TryFinally [] a)

HasTryFinally TryFinally

Defined in Language.Python.Optics

Methods

_TryFinally :: Prism (TryFinally v a) (TryFinally [] a) (TryFinally v a) (TryFinally [] a)

_Finally :: Iso' (Finally v a) (Indents a, [Whitespace], Suite v a)

_Except :: Iso' (Except v a) (Indents a, [Whitespace], Maybe (ExceptAs v a), Suite v a)

else

_Else :: Iso' (Else v a) (Indents a, [Whitespace], Suite v a)

Parameters

_PositionalParam :: Prism (Param v a) (Param '[] a) (PositionalParam v a) (PositionalParam '[] a)

_KeywordParam :: Prism (Param v a) (Param '[] a) (KeywordParam v a) (KeywordParam '[] a)

_UnnamedStarParam :: Prism (Param v a) (Param '[] a) (UnnamedStarParam v a) (UnnamedStarParam '[] a)

_StarParam :: Prism (Param v a) (Param '[] a) (StarParam v a) (StarParam '[] a)

Expressions

Identifiers

_Ident :: (Choice p, Applicative f) => p (Ident v a) (f (Ident '[] a)) -> p (Expr v a) (f (Expr '[] a))

A faux-Prism for matching on the Ident constructor of an SimpleStatement.

It's not a Prism because:

When previewing, it discards the 'Expr'\'s annotation, and when reviewing, it re-constructs an annotation from the supplied Ident

_Ident :: Prism (SimpleStatement v a) (SimpleStatement '[] a) (Expr v a) (Expr '[] a)

None

_None :: Prism (Expr v a) (Expr '[] a) (None v a) (None '[] a)

Function calls

_Call :: Prism (Expr v a) (Expr '[] a) (Call v a) (Call '[] a)

Tuples

_Tuple :: Prism (Expr v a) (Expr '[] a) (Tuple v a) (Tuple '[] a)

_TupleUnpack :: Prism (TupleItem v a) (TupleItem '[] a) (TupleUnpack v a) (TupleUnpack '[] a)

tupleItems :: Traversal (Tuple v a) (Tuple '[] a) (TupleItem v a) (TupleItem '[] a)

Lists

_List :: Prism (Expr v a) (Expr '[] a) (List v a) (List '[] a)

_ListUnpack :: Prism (ListItem v a) (ListItem '[] a) (ListUnpack v a) (ListUnpack '[] a)

listItems :: Traversal (List v a) (List '[] a) (ListItem v a) (ListItem '[] a)