Template psalm-throws

[adrianpanicek]

I could not find any similar issue. I have a usecase

<?php
/**
 * @template T
 *
 * @psalm-param string|null $nullable
 * @psalm-param T $exception
 *
 * @psalm-throws T
 */
function expect(?string $nullable, Exception $exception) 
{
    if ($nullable === null) {
    	throw $exception;
    }
    
    return $nullable;
}
expect('test', new RuntimeException('Test is null'));

My proposal:

@psalm-throws should take generic parameter same as @psalm-param or @psalm-var.

[psalm-github-bot]

Hey @adrianpanicek, can you reproduce the issue on https://psalm.dev ?

[adrianpanicek]

Code on psalm.dev: https://psalm.dev/r/a6bd6f9b18

[psalm-github-bot]

I found these snippets:

https://psalm.dev/r/a6bd6f9b18

<?php

/**
 * @template T
 *
 * @psalm-param string|null $nullable
 * @psalm-param T $exception
 *
 * @psalm-throws T
 */
function expect(?string $nullable, Exception $exception) 
{
    if ($nullable === null) {
    	throw $exception;
    }
    
    return $nullable;
}

Psalm output (using commit 0119cd0):

ERROR: InvalidDocblock - 11:1 - Unrecognised annotation @psalm-throws

INFO: MissingReturnType - 11:10 - Method expect does not have a return type, expecting string

[jmglsn]

Hi,
it seems that I'm trying to to something similar, which is also failing. Maybe it's a potential feature that could be added?

https://psalm.dev/r/ed7ca295c5

<?php

/**
 * @template EntityIdClass
 */
interface IdReferencedEntityNotFoundException extends \Throwable
{
    /**
     * @return ?EntityIdClass
     */
    public function getRequestedId();
}


/**
 * @template EntityIdClass
 * @template EntityClass
 */
interface GenericGetByIdCapableRepository
{
    /**
     * @param  EntityIdClass                                      $id
     * @throws IdReferencedEntityNotFoundException<EntityIdClass>
     * @return EntityClass
     * @psalm-param EntityIdClass $id
     * @psalm-return EntityClass
     */
    public function getById($id);
}

Gives

ERROR: UndefinedDocblockClass - 23:16 - Docblock-defined class, interface or enum named IdReferencedEntityNotFoundException does not exist

I would expect no errors after all.

Thank you!

[psalm-github-bot]

I found these snippets:

https://psalm.dev/r/ed7ca295c5

<?php

/**
 * @template EntityIdClass
 */
interface IdReferencedEntityNotFoundException extends \Throwable
{
    /**
     * @return ?EntityIdClass
     */
    public function getRequestedId();
}


/**
 * @template EntityIdClass
 * @template EntityClass
 */
interface GenericGetByIdCapableRepository
{
    /**
     * @param  EntityIdClass                                      $id
     * @throws IdReferencedEntityNotFoundException<EntityIdClass>
     * @return EntityClass
     * @psalm-param EntityIdClass $id
     * @psalm-return EntityClass
     */
    public function getById($id);
}

Psalm output (using commit f7def9f):

ERROR: UndefinedDocblockClass - 23:16 - Docblock-defined class, interface or enum named IdReferencedEntityNotFoundException<EntityIdClass> does not exist

[adrianpanicek]

Hi,
it seems that I'm trying to to something similar, which is also failing. Maybe it's a potential feature that could be added?

https://psalm.dev/r/ed7ca295c5

<?php

/**
 * @template EntityIdClass
 */
interface IdReferencedEntityNotFoundException extends \Throwable
{
    /**
     * @return ?EntityIdClass
     */
    public function getRequestedId();
}


/**
 * @template EntityIdClass
 * @template EntityClass
 */
interface GenericGetByIdCapableRepository
{
    /**
     * @param  EntityIdClass                                      $id
     * @throws IdReferencedEntityNotFoundException<EntityIdClass>
     * @return EntityClass
     * @psalm-param EntityIdClass $id
     * @psalm-return EntityClass
     */
    public function getById($id);
}

Gives

ERROR: UndefinedDocblockClass - 23:16 - Docblock-defined class, interface or enum named IdReferencedEntityNotFoundException does not exist

I would expect no errors after all.

Thank you!

use @phpstan-throws instead of @throws

[psalm-github-bot]

I found these snippets:

https://psalm.dev/r/ed7ca295c5

<?php

/**
 * @template EntityIdClass
 */
interface IdReferencedEntityNotFoundException extends \Throwable
{
    /**
     * @return ?EntityIdClass
     */
    public function getRequestedId();
}


/**
 * @template EntityIdClass
 * @template EntityClass
 */
interface GenericGetByIdCapableRepository
{
    /**
     * @param  EntityIdClass                                      $id
     * @throws IdReferencedEntityNotFoundException<EntityIdClass>
     * @return EntityClass
     * @psalm-param EntityIdClass $id
     * @psalm-return EntityClass
     */
    public function getById($id);
}

Psalm output (using commit e10b809):

ERROR: UndefinedDocblockClass - 23:16 - Docblock-defined class, interface or enum named IdReferencedEntityNotFoundException<EntityIdClass> does not exist

[jmglsn]

@adrianpanicek thank you!