feature #54788 [TypeInfo] mark classes as experimental (soyuka)

fabpot · fabpot · commit 09e3c5cd542d · 2024-05-02T10:29:02.000+02:00
This PR was merged into the 7.1 branch. Discussion ---------- [TypeInfo] mark classes as experimental | Q | A | ------------- | --- | Branch? | 7.1 | Bug fix? | no | New feature? | no | Deprecations? | no | License | MIT This is following a discussion on slack with authors of the component, I feel that the TypeInfo component should have an experimental phase as we need to prove the component's functionality on software that is built on top of type information extraction. Here's a non-exhaustive list of software using the PropertyInfo Type class (thanks to `@mtarld`): - api-platform/core - nelmio/api-doc-bundle - typo3/cms-extbase - typo3/cms - sonata-project/page-bundle - jolicode/automapper - symfony/ux-live-component These softwares should try their best in testing the new TypeInfo component and report back misfunctionalities and/or DX improvements before we can consider this non-experimental. See also #54789 Commits ------- 28b6495 [TypeInfo] mark classes as experimental
diff --git a/src/Symfony/Component/TypeInfo/CHANGELOG.md b/src/Symfony/Component/TypeInfo/CHANGELOG.md
@@ -4,4 +4,4 @@ CHANGELOG
 7.1
 ---
 
- * Add the component
+ * Add the component as experimental
diff --git a/src/Symfony/Component/TypeInfo/Exception/ExceptionInterface.php b/src/Symfony/Component/TypeInfo/Exception/ExceptionInterface.php
@@ -14,6 +14,8 @@
 /**
  * @author Mathias Arlaud <mathias.arlaud@gmail.com>
  * @author Baptiste Leduc <baptiste.leduc@gmail.com>
+ *
+ * @experimental
  */
 interface ExceptionInterface extends \Throwable
 {
diff --git a/src/Symfony/Component/TypeInfo/Exception/InvalidArgumentException.php b/src/Symfony/Component/TypeInfo/Exception/InvalidArgumentException.php
@@ -14,6 +14,8 @@
 /**
  * @author Mathias Arlaud <mathias.arlaud@gmail.com>
  * @author Baptiste Leduc <baptiste.leduc@gmail.com>
+ *
+ * @experimental
  */
 class InvalidArgumentException extends \InvalidArgumentException implements ExceptionInterface
 {
diff --git a/src/Symfony/Component/TypeInfo/Exception/LogicException.php b/src/Symfony/Component/TypeInfo/Exception/LogicException.php
@@ -14,6 +14,8 @@
 /**
  * @author Mathias Arlaud <mathias.arlaud@gmail.com>
  * @author Baptiste Leduc <baptiste.leduc@gmail.com>
+ *
+ * @experimental
  */
 class LogicException extends \LogicException implements ExceptionInterface
 {
diff --git a/src/Symfony/Component/TypeInfo/Exception/RuntimeException.php b/src/Symfony/Component/TypeInfo/Exception/RuntimeException.php
@@ -14,6 +14,8 @@
 /**
  * @author Mathias Arlaud <mathias.arlaud@gmail.com>
  * @author Baptiste Leduc <baptiste.leduc@gmail.com>
+ *
+ * @experimental
  */
 class RuntimeException extends \RuntimeException implements ExceptionInterface
 {
diff --git a/src/Symfony/Component/TypeInfo/Exception/UnsupportedException.php b/src/Symfony/Component/TypeInfo/Exception/UnsupportedException.php
@@ -14,6 +14,8 @@
 /**
  * @author Mathias Arlaud <mathias.arlaud@gmail.com>
  * @author Baptiste Leduc <baptiste.leduc@gmail.com>
+ *
+ * @experimental
  */
 class UnsupportedException extends \LogicException implements ExceptionInterface
 {
diff --git a/src/Symfony/Component/TypeInfo/README.md b/src/Symfony/Component/TypeInfo/README.md
@@ -3,6 +3,11 @@ TypeInfo Component
 
 The TypeInfo component extracts PHP types information.
 
+**This Component is experimental**.
+[Experimental features](https://symfony.com/doc/current/contributing/code/experimental.html)
+are not covered by Symfony's
+[Backward Compatibility Promise](https://symfony.com/doc/current/contributing/code/bc.html).
+
 Getting Started
 ---------------
 
diff --git a/src/Symfony/Component/TypeInfo/Type.php b/src/Symfony/Component/TypeInfo/Type.php
@@ -17,6 +17,8 @@
 /**
  * @author Mathias Arlaud <mathias.arlaud@gmail.com>
  * @author Baptiste Leduc <baptiste.leduc@gmail.com>
+ *
+ * @experimental
  */
 abstract class Type implements \Stringable
 {
diff --git a/src/Symfony/Component/TypeInfo/Type/BackedEnumType.php b/src/Symfony/Component/TypeInfo/Type/BackedEnumType.php
@@ -21,6 +21,8 @@
  * @template U of BuiltinType<TypeIdentifier::INT>|BuiltinType<TypeIdentifier::STRING>
  *
  * @extends EnumType<T>
+ *
+ * @experimental
  */
 final class BackedEnumType extends EnumType
 {
diff --git a/src/Symfony/Component/TypeInfo/Type/BuiltinType.php b/src/Symfony/Component/TypeInfo/Type/BuiltinType.php
@@ -20,6 +20,8 @@
  * @author Baptiste Leduc <baptiste.leduc@gmail.com>
  *
  * @template T of TypeIdentifier
+ *
+ * @experimental
  */
 final class BuiltinType extends Type
 {
diff --git a/src/Symfony/Component/TypeInfo/Type/CollectionType.php b/src/Symfony/Component/TypeInfo/Type/CollectionType.php
@@ -24,6 +24,8 @@
  * @author Baptiste Leduc <baptiste.leduc@gmail.com>
  *
  * @template T of BuiltinType<TypeIdentifier::ARRAY>|BuiltinType<TypeIdentifier::ITERABLE>|ObjectType|GenericType
+ *
+ * @experimental
  */
 final class CollectionType extends Type
 {
diff --git a/src/Symfony/Component/TypeInfo/Type/EnumType.php b/src/Symfony/Component/TypeInfo/Type/EnumType.php
@@ -18,6 +18,8 @@
  * @template T of class-string<\UnitEnum>
  *
  * @extends ObjectType<T>
+ *
+ * @experimental
  */
 class EnumType extends ObjectType
 {
diff --git a/src/Symfony/Component/TypeInfo/Type/GenericType.php b/src/Symfony/Component/TypeInfo/Type/GenericType.php
@@ -23,6 +23,8 @@
  * @author Baptiste Leduc <baptiste.leduc@gmail.com>
  *
  * @template T of BuiltinType<TypeIdentifier::ARRAY>|BuiltinType<TypeIdentifier::ITERABLE>|ObjectType
+ *
+ * @experimental
  */
 final class GenericType extends Type
 {
diff --git a/src/Symfony/Component/TypeInfo/Type/IntersectionType.php b/src/Symfony/Component/TypeInfo/Type/IntersectionType.php
@@ -19,6 +19,8 @@
  * @author Baptiste Leduc <baptiste.leduc@gmail.com>
  *
  * @template T of Type
+ *
+ * @experimental
  */
 final class IntersectionType extends Type
 {
diff --git a/src/Symfony/Component/TypeInfo/Type/ObjectType.php b/src/Symfony/Component/TypeInfo/Type/ObjectType.php
@@ -19,6 +19,8 @@
  * @author Baptiste Leduc <baptiste.leduc@gmail.com>
  *
  * @template T of class-string
+ *
+ * @experimental
  */
 class ObjectType extends Type
 {
diff --git a/src/Symfony/Component/TypeInfo/Type/TemplateType.php b/src/Symfony/Component/TypeInfo/Type/TemplateType.php
@@ -19,6 +19,8 @@
  *
  * @author Mathias Arlaud <mathias.arlaud@gmail.com>
  * @author Baptiste Leduc <baptiste.leduc@gmail.com>
+ *
+ * @experimental
  */
 final class TemplateType extends Type
 {
diff --git a/src/Symfony/Component/TypeInfo/Type/UnionType.php b/src/Symfony/Component/TypeInfo/Type/UnionType.php
@@ -19,6 +19,8 @@
  * @author Baptiste Leduc <baptiste.leduc@gmail.com>
  *
  * @template T of Type
+ *
+ * @experimental
  */
 final class UnionType extends Type
 {
diff --git a/src/Symfony/Component/TypeInfo/TypeContext/TypeContext.php b/src/Symfony/Component/TypeInfo/TypeContext/TypeContext.php
@@ -22,6 +22,8 @@
  *
  * @author Mathias Arlaud <mathias.arlaud@gmail.com>
  * @author Baptiste Leduc <baptiste.leduc@gmail.com>
+ *
+ * @experimental
  */
 final class TypeContext
 {
diff --git a/src/Symfony/Component/TypeInfo/TypeContext/TypeContextFactory.php b/src/Symfony/Component/TypeInfo/TypeContext/TypeContextFactory.php
@@ -27,6 +27,8 @@
  *
  * @author Mathias Arlaud <mathias.arlaud@gmail.com>
  * @author Baptiste Leduc <baptiste.leduc@gmail.com>
+ *
+ * @experimental
  */
 final class TypeContextFactory
 {
diff --git a/src/Symfony/Component/TypeInfo/TypeFactoryTrait.php b/src/Symfony/Component/TypeInfo/TypeFactoryTrait.php
@@ -26,6 +26,8 @@
  *
  * @author Mathias Arlaud <mathias.arlaud@gmail.com>
  * @author Baptiste Leduc <baptiste.leduc@gmail.com>
+ *
+ * @experimental
  */
 trait TypeFactoryTrait
 {
diff --git a/src/Symfony/Component/TypeInfo/TypeIdentifier.php b/src/Symfony/Component/TypeInfo/TypeIdentifier.php
@@ -16,6 +16,8 @@
  *
  * @author Mathias Arlaud <mathias.arlaud@gmail.com>
  * @author Baptiste Leduc <baptiste.leduc@gmail.com>
+ *
+ * @experimental
  */
 enum TypeIdentifier: string
 {
diff --git a/src/Symfony/Component/TypeInfo/TypeResolver/TypeResolver.php b/src/Symfony/Component/TypeInfo/TypeResolver/TypeResolver.php
@@ -23,6 +23,8 @@
  *
  * @author Mathias Arlaud <mathias.arlaud@gmail.com>
  * @author Baptiste Leduc <baptiste.leduc@gmail.com>
+ *
+ * @experimental
  */
 final readonly class TypeResolver implements TypeResolverInterface
 {
diff --git a/src/Symfony/Component/TypeInfo/TypeResolver/TypeResolverInterface.php b/src/Symfony/Component/TypeInfo/TypeResolver/TypeResolverInterface.php
@@ -20,6 +20,8 @@
  *
  * @author Mathias Arlaud <mathias.arlaud@gmail.com>
  * @author Baptiste Leduc <baptiste.leduc@gmail.com>
+ *
+ * @experimental
  */
 interface TypeResolverInterface
 {

Original file line number	Diff line number	Diff line change
`@@ -14,6 +14,8 @@`
`14`	`14`	`/**`
`15`	`15`	`* @author Mathias Arlaud <mathias.arlaud@gmail.com>`
`16`	`16`	`* @author Baptiste Leduc <baptiste.leduc@gmail.com>`
	`17`	`+ *`
	`18`	`+ * @experimental`
`17`	`19`	`*/`
`18`	`20`	`interface ExceptionInterface extends \Throwable`
`19`	`21`	`{`
Original file line number	Diff line number	Diff line change
`@@ -17,6 +17,8 @@`
`17`	`17`	`/**`
`18`	`18`	`* @author Mathias Arlaud <mathias.arlaud@gmail.com>`
`19`	`19`	`* @author Baptiste Leduc <baptiste.leduc@gmail.com>`
	`20`	`+ *`
	`21`	`+ * @experimental`
`20`	`22`	`*/`
`21`	`23`	`abstract class Type implements \Stringable`
`22`	`24`	`{`
Original file line number	Diff line number	Diff line change
`@@ -21,6 +21,8 @@`
`21`	`21`	`* @template U of BuiltinType<TypeIdentifier::INT>\|BuiltinType<TypeIdentifier::STRING>`
`22`	`22`	`*`
`23`	`23`	`* @extends EnumType<T>`
	`24`	`+ *`
	`25`	`+ * @experimental`
`24`	`26`	`*/`
`25`	`27`	`final class BackedEnumType extends EnumType`
`26`	`28`	`{`
Original file line number	Diff line number	Diff line change
`@@ -20,6 +20,8 @@`
`20`	`20`	`* @author Baptiste Leduc <baptiste.leduc@gmail.com>`
`21`	`21`	`*`
`22`	`22`	`* @template T of TypeIdentifier`
	`23`	`+ *`
	`24`	`+ * @experimental`
`23`	`25`	`*/`
`24`	`26`	`final class BuiltinType extends Type`
`25`	`27`	`{`