sezaru
Proposal: Support for __PARENT_MODULE__ (or some other better name)
When writing my code, I always find __MODULE__ very useful to use as alias of that module “inner dependencies”, ex:
alias __MODULE__.{Impl, Helper, ...}
But one thing that I always find missing is that when I want to get some dependency for a module in the same “level” that my current module, I need to write the full module path, ex:
defmodule My.Big.Module.Path.Something do
alias My.Big.Module.Path.SomethingElse
...
end
I feel that having something like __PARENT_MODULE__ would be useful in these cases. Also, the impact on the existing eco-system would be zero since it doesn’t break any existing code.
Here are more “concrete examples” of when this can come in handy:
When organizing behaviours
The way I organize them is something like this:
# The behaviour module
Some.Module.MyBehaviour
# The modules implementing it
Some.Module.MyBehaviour.Impl1
Some.Module.MyBehaviour.Impl2
Some.Module.MyBehaviour.Impl3
In these cases, I could write something like @behaviour __PARENT_MODULE__ and @impl __PARENT_MODULE__ instead of @behaviour Some.Module.MyBehaviour and @impl Some.Module.MyBehaviour
When organizing gen servers and scoped business logic
If my genservers are getting big or complex, I like to split them into smaller parts, normally what I do is have something like this:
# This module will have the genserver child_spec and public APIS
Some.Module.Path.MyGenServer
# This module will have all the genserver code implementation (handle_call, start_async, etc)
Some.Module.Path.MyGenServer.Server
# This module will have all the genserver business logic
Some.Module.Path.MyGenServer.Impl
# And this module will have the genserver state struct and how to create/update it
Some.Module.Path.MyGenServer.State
Now, for example, the Server module needs to call Impl functions, and the Impl module needs to call State functions. Making the usage of __PARENT_MODULE__ useful here.
I don’t know if that is normally an issue for other people, but the project I work is pretty big and have some pretty big module names, so having something like that would make writing some code way faster for me.
Most Liked
sodapopcan
I don’t hate this and have found myself wanting it for cases like your first example. However, there is already confusion around there not actually being a module hierarchy and feel this could make it worse. It’s also something that won’t “just work” when you rename a module referenced by this.
Personally, I’m overall indifferent as I don’t find status quo to be too much of a pain.
jswanner
To expand upon this with examples…
Module A.B.C is not contained within module A.B nor A, they are completely separate modules whose names start the same.
Even when writing code such as:
defmodule A do
defmodule B do
def b, do: "b"
end
def a, do: B.b()
end
Module A.B is still not truly contained within module A (A.B is not a child of A) but the above works as a convenience.
sodapopcan
Your example of alias __MODULE__, as: User would definitely make grepping harder, though that is really only because of the :as. Personally I think :as should really only ever be used for getting around naming conflicts.
Otherwise for me I find the cognitive burden goes the other way. when I see __MODULE__ I immediately think “current module.” On the other hand:
defmodule Foo.Bar do
# ... many line
def something(%Foo.Bar{} = bar) do
# ...
end
end
Seeing %Foo.Bar{} here immediately makes me think “a remote module” and it often takes me many moments to figure it out, which sucks when you’re scanning.
Popular in Proposals: Ideas
Other popular topics
Categories:
Sub Categories:
Forums
Popular Tags
- #ecto
- #liveview
- #troubleshooting
- #learning-elixir
- #deployment
- #library
- #erlang
- #testing
- #genserver
- #mix
- #absinthe
- #remote-other
- #otp
- #plug
- #how-to-question
- #macros
- #postgres
- #channels
- #elixirconf
- #exunit
- #discussion
- #code-sync
- #javascript
- #podcasts
- #onsite
- #dialyzer
- #docker
- #authentication
- #umbrella
- #full-time-contract
- #podcasts-by-brainlid
- #ecto-query
- #elixir-ls
- #phoenix_html
- #iex
- #blog-post
- #graphql
- #genstage
- #ai
- #websockets
- #supervisor
- #advent-of-code
- #elixirconf-us
- #distillery
- #processes
- #forms
- #api
- #metaprogramming
- #security
- #performance








