UML diagram of lxml.etree Element inheritance in source and in stub

readme.md

Explanation

These are source of UML diagrams representing lxml Element inheritance.

• First diagram illustrated how lxml.etree.Element inheritance happens in source
• Second diagram shows how inheritance is changed in types-lxml package

They are used in types-lxml wiki for explaining how and why the changes are done.

Rendering

The diagrams can be rendered by PlantUML. Mermaid, though officially supported in GitHub Wiki, is not chosen because it does not support namespace / package yet.

lxml-element-source.uml

@startuml
!theme materia
hide empty members
!$notable_cls_color = "#header:Teal|DarkTurquoise"

skinparam title {
  RoundCorner 15
  BorderThickness 2
  Padding 10
  FontSize 24
}

skinparam classFontSize 14
skinparam classFontColor white
skinparam backgroundColor transparent

title Lxml Element Class Inheritance

!procedure $notable($class)
  class $class $notable_cls_color
!endprocedure

package lxml.etree #LightSteelBlue {

  class "_Element"
  "__ContentOnlyElement" -|> "_Element"
  "__ContentOnlyElement" <|-- "_Comment"
  "__ContentOnlyElement" <|-- "_ProcessingInstruction"
  "__ContentOnlyElement" <|-- "_Entity"
  
  "_Comment" <|-- CommentBase
  "_ProcessingInstruction" <|-- PIBase
  "_Entity" <|-- EntityBase
  "_Element" <|--- ElementBase

  $notable("_Element")
}

package "lxml.html" #PaleGreen {

  lxml.etree.ElementBase <|-- HtmlElement
  lxml.etree.CommentBase <|-- HtmlComment
  lxml.etree.PIBase <|-- HtmlPI
  lxml.etree.EntityBase <|-- HtmlEntity

  HtmlElement --|> HtmlMixin
  HtmlComment --|> HtmlMixin
  HtmlPI --|> HtmlMixin
  HtmlEntity --|> HtmlMixin

  package "Form related" #SteelBlue|CornFlowerBlue {
  }
  HtmlElement <|-- "Form related"
  HtmlElement <|-- LabelElement

  $notable("HtmlElement")
}

package "lxml.objectify" #LightSkyBlue {

  lxml.etree.ElementBase <|-- ObjectifiedElement
  ObjectifiedElement <|-- ObjectifiedDataElement

  $notable("ObjectifiedElement")
}

@enduml

lxml-element-stub.uml

@startuml
!theme materia
hide empty members
!$notable_cls_color = "#header:Teal|DarkTurquoise"
!$changed_cls_color = "#header:Orchid|MediumOrchid"

skinparam title {
  RoundCorner 15
  BorderThickness 2
  Padding 10
  FontSize 24
}

skinparam classFontSize 14
skinparam classFontColor white
skinparam backgroundColor transparent

title Lxml Element Class Inheritance in stub

!procedure $notable($class)
  class $class $notable_cls_color
!endprocedure

!procedure $changed($class)
  class $class $changed_cls_color
!endprocedure

package lxml.etree #LightSteelBlue {

  class "_Element"
  "__ContentOnlyElement" -|> "_Element"
  "__ContentOnlyElement" <|-- "_Comment"
  "__ContentOnlyElement" <|-- "_ProcessingInstruction"
  "__ContentOnlyElement" <|-- "_Entity"
  
  "_Comment" <|-- CommentBase
  "_ProcessingInstruction" <|-- PIBase
  "_Entity" <|-- EntityBase
  "_Element" <|--- ElementBase

  $notable("_Element")
}

package "lxml.html" #PaleGreen {

  class "HtmlElement" {
    {field} merge all HtmlMixin properties
    {method} merge all HtmlMixin methods
  }
  lxml.etree.ElementBase <|-- HtmlElement
  lxml.etree.CommentBase <|--- HtmlComment
  lxml.etree.EntityBase <|--- HtmlEntity

  HtmlElement <|-- HtmlComment
  HtmlElement <|-- HtmlEntity

  package "Form related" #SteelBlue|CornFlowerBlue {
  }
  HtmlElement <|-- "Form related"
  HtmlElement <|-- LabelElement

  $notable("HtmlElement")
  $changed("HtmlComment")
  $changed("HtmlEntity")
}

package "lxml.objectify" #LightSkyBlue {

  lxml.etree.ElementBase <|-- ObjectifiedElement
  ObjectifiedElement <|-- ObjectifiedDataElement

  $notable("ObjectifiedElement")
}

@enduml